Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs updates #21

Merged
merged 4 commits into from
Apr 8, 2024
Merged

docs updates #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b388923
ignore CRAN-SUBMISSION
mghoff Nov 18, 2023
882241e
Roxygen2 update
mghoff Mar 7, 2024
5bdc8fc
sharpen doc around `data` inut argument
mghoff Mar 7, 2024
d246491
spelling update
mghoff Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ README.html
doc
Meta
docs
^CRAN-SUBMISSION$
CRAN-SUBMISSION
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Encoding: UTF-8
Language: en-US
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
5 changes: 4 additions & 1 deletion R/data.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions R/eia.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions inst/WORDLIST
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ EIA’s
Github
JSON
Memoization
ORCID
RStudio
asc
desc
Expand Down
17 changes: 17 additions & 0 deletions man/eia.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion man/eia_data.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading