Changes to documentation ahead of CRAN submission

coderaanalytics · Aug 21, 2024 · d651651 · d651651
1 parent a851ec7
commit d651651
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 10 deletions.
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 = "[email protected]"),
              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()