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.

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

fix documentation issues #165

Merged
merged 5 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Remotes:
Imports:
httr,
readr,
sf,
utils,
EML,
magrittr,
Expand All @@ -46,15 +45,16 @@ Imports:
curl,
mockr,
rlang,
ISOcodes,
gdata
Suggests:
arcticdatautils,
stargazer,
knitr,
rmarkdown,
testthat (>= 3.0.0),
QCkit
QCkit,
ISOcodes,
gdata,
sf
Config/testthat/edition: 3
URL: https://github.com/nationalparkservice/EMLeditor
VignetteBuilder: knitr
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# EMLeditor v0.1.7 (under development)
## 2024-10-23
* updates and fixes to documentation including spelling, grammar, and clarity
* remove non-exported functions from documentation
* move several packages from Imports to Suggests (ISOcodes, sf, gdata)

# EMLeditor v0.1.6
## 2024-09-17
* Update `set_content_units` to have correct east and west GPS coordinates for bounding boxes.
Expand Down
6 changes: 6 additions & 0 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ globalVariables(c("UnitCode",
#' @param eml_object is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(<filename>, from="xml").
#'
#' @return eml_object
#' @noRd
#'
#' @examples
#' \dontrun{
Expand Down Expand Up @@ -93,6 +94,7 @@ globalVariables(c("UnitCode",
#' @details .set_version adds the current version of EMLeditor to the metadata, specifically in the "additionalMetadata" element
#'
#' @inheritParams .set_npspublisher
#' @noRd
#'
#' @return eml_object
#'
Expand Down Expand Up @@ -167,6 +169,7 @@ globalVariables(c("UnitCode",
#'
#' @return well known text (wkt) convex hull of an NPS park unit.
#'
#' @noRd
#' @examples
#' \dontrun{
#' poly <- .get_unit_polygon("BICY")
Expand Down Expand Up @@ -197,6 +200,7 @@ globalVariables(c("UnitCode",
#' @inheritParams .set_npspublisher
#'
#' @return eml_object
#' @noRd
#'
#' @examples
#' \dontrun{
Expand Down Expand Up @@ -255,6 +259,7 @@ globalVariables(c("UnitCode",
#' Prompts for, gets, and returns binary user input (1 or 2)
#'
#' @return Factor. 1 or 2.
#' @noRd
#'
#' @examples
#' \dontrun{
Expand All @@ -271,6 +276,7 @@ globalVariables(c("UnitCode",
#'
#' @return character, typically 1, 2, or 3 but could be any character string.
#' @export
#' @noRd
#'
#' @examples
#' \dontrun{
Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE.html

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

2 changes: 1 addition & 1 deletion docs/articles/a01_prereqs.html

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

2 changes: 1 addition & 1 deletion docs/articles/a02_EML_creation_script.html

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

2 changes: 1 addition & 1 deletion docs/articles/a03_Template_edits.html

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

2 changes: 1 addition & 1 deletion docs/articles/a04_Editing_fixing_eml.html

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

2 changes: 1 addition & 1 deletion docs/articles/a05_advanced_functionality.html

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

2 changes: 1 addition & 1 deletion docs/articles/index.html

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

2 changes: 1 addition & 1 deletion docs/authors.html

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

2 changes: 1 addition & 1 deletion docs/index.html

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

13 changes: 11 additions & 2 deletions docs/news/index.html

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

6 changes: 3 additions & 3 deletions docs/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
pandoc: '3.2'
pkgdown: 2.1.1
pandoc: 3.1.11
pkgdown: 2.1.0
pkgdown_sha: ~
articles:
a01_prereqs: a01_prereqs.html
a02_EML_creation_script: a02_EML_creation_script.html
a03_Template_edits: a03_Template_edits.html
a04_Editing_fixing_eml: a04_Editing_fixing_eml.html
a05_advanced_functionality: a05_advanced_functionality.html
last_built: 2024-10-23T13:19Z
last_built: 2024-10-23T14:29Z
2 changes: 1 addition & 1 deletion docs/reference/EMLeditor-package.html

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

Binary file removed docs/reference/Rplot001.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/reference/check_eml.html

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

128 changes: 0 additions & 128 deletions docs/reference/dot-get_unit_polygon.html

This file was deleted.

Loading
Loading