Merge pull request #21 from ropensci/dev

docs updates
ropensci · Apr 8, 2024 · 202d5f2 · 202d5f2
2 parents 98f620f + d246491
commit 202d5f2
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,4 @@ README.html
 doc
 Meta
 docs
-^CRAN-SUBMISSION$
+CRAN-SUBMISSION
diff --git 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
@@ -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
@@ -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
@@ -6,6 +6,7 @@ EIA’s
 Github
 JSON
 Memoization
+ORCID
 RStudio
 asc
 desc

diff --git a/man/eia.Rd b/man/eia.Rd
diff --git a/man/eia_data.Rd b/man/eia_data.Rd