Changes to documentation ahead of CRAN submission

byrongibby · byrongibby · commit d651651b850a · 2024-08-21T11:14:38.000+02:00
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: econdatar
 Title: Automation of Data Tasks to and from Codera Analytics' Econometric Data Services
 Version: 3.1.0
-Date: 2024-04-24
+Date: 2024-08-19
 Authors@R: c(person(given = "Byron", family = "Botha", role = c("aut", "cre"), email = "econdata@codera.co.za"),
              person(given = "Sebastian", family = "Krantz", role = "ctb"))
 Description: Automation of data tasks to and from <https://codera.co.za> econometric data services. Using this package users can download data from <https://www.econdata.co.za> directly into R (in tidy format) after signing up for a free account. <https://www.econdata.co.za> hosts a comprehensive database of South African macroeconomic data. For support and tutorials please see <https://econdata.co.za>.
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2023, Codera Analytics
+Copyright (c) 2024, Codera Analytics
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
diff --git a/R/tidy_data.R b/R/tidy_data.R
@@ -34,6 +34,7 @@ add_version_names <- function(x, is_release = FALSE) {
 }
 
 tidy_wide <- function(x, codelabel = FALSE, prettymeta = TRUE, ...) {
+  time_period <- NULL
   if (is.null(names(x))) return(lapply(add_version_names(x),
                                        tidy_wide,
                                        codelabel,
@@ -77,6 +78,7 @@ extract_metadata <- function(x, meta, allmeta = FALSE, origmeta = FALSE) {
 }
 
 tidy_long <- function(x, combine = FALSE, allmeta = FALSE, origmeta = FALSE, prettymeta = TRUE, ...) {
+  time_period <- NULL
   if (is.null(names(x))) {
     res <- lapply(add_version_names(x),
                   tidy_long,
diff --git a/man/econdatar-package.Rd b/man/econdatar-package.Rd
@@ -28,7 +28,7 @@ https://www.econdata.co.za
 https://econdata.co.za
 }
 \examples{
-\donttest{
+\dontrun{
 # library(econdatar)
 
 # Return all data sets (useful for browsing available data)
diff --git a/man/read_database.Rd b/man/read_database.Rd
@@ -38,7 +38,7 @@ If \code{tidy = TRUE} a single \emph{data.table} is returned with columns for \c
 \code{\link{write_database}}
 }
 \examples{
-\donttest{
+\dontrun{
 # library(econdatar)
 
 # Mining production and sales
diff --git a/man/read_dataset.Rd b/man/read_dataset.Rd
@@ -60,7 +60,7 @@ If \code{tidy = TRUE} and \code{wide = FALSE} and \code{compact = FALSE} (the de
 \code{\link{read_release}}
 }
 \examples{
-\donttest{
+\dontrun{
 # library(econdatar)
 
 # Electricity Generated
diff --git a/man/read_econdata.Rd b/man/read_econdata.Rd
@@ -59,7 +59,7 @@ If \code{tidy = TRUE} and \code{wide = FALSE} and \code{compact = FALSE} (the de
 \code{\link{read_release}}
 }
 \examples{
-\donttest{
+\dontrun{
 # library(econdatar)
 
 # Electricity Generated
diff --git a/man/read_registry.Rd b/man/read_registry.Rd
@@ -37,7 +37,7 @@ If \code{tidy = FALSE}, a list detailing at a minimum the structure's agencyid,
 \code{\link{write_registry}}
 }
 \examples{
-\donttest{
+\dontrun{
 # library(econdatar)
 
 # Frequency codelist
diff --git a/man/read_release.Rd b/man/read_release.Rd
@@ -41,7 +41,7 @@ If \code{tidy = FALSE}, a nested lists containing metadata and release desciptio
 \code{\link{read_econdata}}
 }
 \examples{
-\donttest{
+\dontrun{
 # library(econdatar)
 
 # Bank Balance Sheet (institutional)
diff --git a/man/write_econdata.Rd b/man/write_econdata.Rd
@@ -34,7 +34,7 @@ No return value, called for side-effects - writes data to server.
 \code{\link{write_release}}
 }
 \examples{
-\donttest{
+\dontrun{
 x <- read_econdata("MINING")
 
 tmp <- tempdir()
diff --git a/man/write_registry.Rd b/man/write_registry.Rd
@@ -32,7 +32,7 @@ No return value, called for side-effects - writes data to server.
 \code{\link{read_registry}}
 }
 \examples{
-\donttest{
+\dontrun{
 x <- read_registry("codelist", id = "CL_FREQ")
 
 tmp <- tempdir()

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2023, Codera Analytics`
	`1`	`+Copyright (c) 2024, Codera Analytics`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining`
`4`	`4`	`a copy of this software and associated documentation files (the`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ add_version_names <- function(x, is_release = FALSE) {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`tidy_wide <- function(x, codelabel = FALSE, prettymeta = TRUE, ...) {`
	`37`	`+ time_period <- NULL`
`37`	`38`	`if (is.null(names(x))) return(lapply(add_version_names(x),`
`38`	`39`	`tidy_wide,`
`39`	`40`	`codelabel,`
`@@ -77,6 +78,7 @@ extract_metadata <- function(x, meta, allmeta = FALSE, origmeta = FALSE) {`
`77`	`78`	`}`
`78`	`79`
`79`	`80`	`tidy_long <- function(x, combine = FALSE, allmeta = FALSE, origmeta = FALSE, prettymeta = TRUE, ...) {`
	`81`	`+ time_period <- NULL`
`80`	`82`	`if (is.null(names(x))) {`
`81`	`83`	`res <- lapply(add_version_names(x),`
`82`	`84`	`tidy_long,`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ https://www.econdata.co.za`
`28`	`28`	`https://econdata.co.za`
`29`	`29`	`}`
`30`	`30`	`\examples{`
`31`		`-\donttest{`
	`31`	`+\dontrun{`
`32`	`32`	`# library(econdatar)`
`33`	`33`
`34`	`34`	`# Return all data sets (useful for browsing available data)`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ If \code{tidy = TRUE} a single \emph{data.table} is returned with columns for \c`
`38`	`38`	`\code{\link{write_database}}`
`39`	`39`	`}`
`40`	`40`	`\examples{`
`41`		`-\donttest{`
	`41`	`+\dontrun{`
`42`	`42`	`# library(econdatar)`
`43`	`43`
`44`	`44`	`# Mining production and sales`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ If \code{tidy = TRUE} and \code{wide = FALSE} and \code{compact = FALSE} (the de`
`60`	`60`	`\code{\link{read_release}}`
`61`	`61`	`}`
`62`	`62`	`\examples{`
`63`		`-\donttest{`
	`63`	`+\dontrun{`
`64`	`64`	`# library(econdatar)`
`65`	`65`
`66`	`66`	`# Electricity Generated`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ If \code{tidy = TRUE} and \code{wide = FALSE} and \code{compact = FALSE} (the de`
`59`	`59`	`\code{\link{read_release}}`
`60`	`60`	`}`
`61`	`61`	`\examples{`
`62`		`-\donttest{`
	`62`	`+\dontrun{`
`63`	`63`	`# library(econdatar)`
`64`	`64`
`65`	`65`	`# Electricity Generated`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ If \code{tidy = FALSE}, a list detailing at a minimum the structure's agencyid,`
`37`	`37`	`\code{\link{write_registry}}`
`38`	`38`	`}`
`39`	`39`	`\examples{`
`40`		`-\donttest{`
	`40`	`+\dontrun{`
`41`	`41`	`# library(econdatar)`
`42`	`42`
`43`	`43`	`# Frequency codelist`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ If \code{tidy = FALSE}, a nested lists containing metadata and release desciptio`
`41`	`41`	`\code{\link{read_econdata}}`
`42`	`42`	`}`
`43`	`43`	`\examples{`
`44`		`-\donttest{`
	`44`	`+\dontrun{`
`45`	`45`	`# library(econdatar)`
`46`	`46`
`47`	`47`	`# Bank Balance Sheet (institutional)`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ No return value, called for side-effects - writes data to server.`
`34`	`34`	`\code{\link{write_release}}`
`35`	`35`	`}`
`36`	`36`	`\examples{`
`37`		`-\donttest{`
	`37`	`+\dontrun{`
`38`	`38`	`x <- read_econdata("MINING")`
`39`	`39`
`40`	`40`	`tmp <- tempdir()`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ No return value, called for side-effects - writes data to server.`
`32`	`32`	`\code{\link{read_registry}}`
`33`	`33`	`}`
`34`	`34`	`\examples{`
`35`		`-\donttest{`
	`35`	`+\dontrun{`
`36`	`36`	`x <- read_registry("codelist", id = "CL_FREQ")`
`37`	`37`
`38`	`38`	`tmp <- tempdir()`