diff --git a/.gitignore b/.gitignore index ad70ccb..7d4e0dd 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,4 @@ README.html doc Meta docs -^CRAN-SUBMISSION$ +CRAN-SUBMISSION diff --git a/DESCRIPTION b/DESCRIPTION index 2130d92..d6c0251 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -47,4 +47,4 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 diff --git a/R/data.R b/R/data.R index 50ea4ab..138764e 100644 --- a/R/data.R +++ b/R/data.R @@ -25,7 +25,10 @@ #' You can reset the entire cache by calling `eia_clear_cache()`. #' #' @param dir character, directory path. -#' @param data character or `NULL`, see details. +#' @param data character or `NULL`, +#' * note: if `NULL`, `eia_data()` will only return column headings; must input a character value +#' as provided by `eia_metadata()` for data to be returned. +#' * see details. #' @param facets character list or `NULL`, see details. #' @param freq character or `NULL`, see details. #' @param start,end character or `NULL`, see details. diff --git a/R/eia.R b/R/eia.R index 1a26539..30560e4 100644 --- a/R/eia.R +++ b/R/eia.R @@ -4,10 +4,9 @@ globalVariables(".data") #' #' This package provides API access to data from the US #' \href{https://www.eia.gov/}{Energy Information Administration} (EIA). -#' @docType package #' @name eia #' @aliases eia-package -NULL +"_PACKAGE" #' @importFrom tibble tibble NULL diff --git a/inst/WORDLIST b/inst/WORDLIST index 344d281..b2f854e 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -6,6 +6,7 @@ EIA’s Github JSON Memoization +ORCID RStudio asc desc diff --git a/man/eia.Rd b/man/eia.Rd index 973645b..0c39c95 100644 --- a/man/eia.Rd +++ b/man/eia.Rd @@ -9,3 +9,20 @@ This package provides API access to data from the US \href{https://www.eia.gov/}{Energy Information Administration} (EIA). } +\seealso{ +Useful links: +\itemize{ + \item \url{https://docs.ropensci.org/eia/ (website) https://github.com/ropensci/eia} + \item Report bugs at \url{https://github.com/ropensci/eia/issues} +} + +} +\author{ +\strong{Maintainer}: Matthew Hoff \email{matthew.g.hoff@gmail.com} + +Authors: +\itemize{ + \item Matthew Leonawicz (\href{https://orcid.org/0000-0001-9452-2771}{ORCID}) +} + +} diff --git a/man/eia_data.Rd b/man/eia_data.Rd index 12b3c35..8aee65f 100644 --- a/man/eia_data.Rd +++ b/man/eia_data.Rd @@ -23,7 +23,12 @@ eia_data( \arguments{ \item{dir}{character, directory path.} -\item{data}{character or \code{NULL}, see details.} +\item{data}{character or \code{NULL}, +\itemize{ +\item note: if \code{NULL}, \code{eia_data()} will only return column headings; must input a character value +as provided by \code{eia_metadata()} for data to be returned. +\item see details. +}} \item{facets}{character list or \code{NULL}, see details.}