From 57ee3c8a41e3b1cfcb27dfe8db883bf1ecbb65d1 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Wed, 23 Oct 2024 08:05:18 -0600 Subject: [PATCH 1/5] add @noRd roxygen tag to non-exported functions to keep them out of the documentation --- R/utils.R | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/R/utils.R b/R/utils.R index 3ef7f5f..a9fe7da 100644 --- a/R/utils.R +++ b/R/utils.R @@ -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(, from="xml"). #' #' @return eml_object +#' @noRd #' #' @examples #' \dontrun{ @@ -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 #' @@ -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") @@ -197,6 +200,7 @@ globalVariables(c("UnitCode", #' @inheritParams .set_npspublisher #' #' @return eml_object +#' @noRd #' #' @examples #' \dontrun{ @@ -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{ @@ -271,6 +276,7 @@ globalVariables(c("UnitCode", #' #' @return character, typically 1, 2, or 3 but could be any character string. #' @export +#' @noRd #' #' @examples #' \dontrun{ From fb17ae5609d714908365cd9b4ed044aadd297cd4 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Wed, 23 Oct 2024 08:22:22 -0600 Subject: [PATCH 2/5] move ISOcodes, gdata, sf from Imports to Suggests --- DESCRIPTION | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 160efde..32eb50e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -27,7 +27,6 @@ Remotes: Imports: httr, readr, - sf, utils, EML, magrittr, @@ -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 From 65c0350d0fb33cefd76988fb7b174909a933f306 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Wed, 23 Oct 2024 08:26:04 -0600 Subject: [PATCH 3/5] add updates to NEWS including documentation fixes, removing non-exported functions from documentation and moving rarely used dependencies from Imports to Suggests --- NEWS.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/NEWS.md b/NEWS.md index fb87788..d7efc95 100644 --- a/NEWS.md +++ b/NEWS.md @@ -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. From c25d30deddceb0f4471fa71a8d22e66cbad7cc23 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Wed, 23 Oct 2024 08:26:33 -0600 Subject: [PATCH 4/5] devtools::document() and pkgdown::build_site_github_pages() --- docs/404.html | 2 +- docs/LICENSE-text.html | 2 +- docs/LICENSE.html | 2 +- docs/articles/a01_prereqs.html | 2 +- docs/articles/a02_EML_creation_script.html | 2 +- docs/articles/a03_Template_edits.html | 2 +- docs/articles/a04_Editing_fixing_eml.html | 2 +- docs/articles/a05_advanced_functionality.html | 2 +- docs/articles/index.html | 2 +- docs/authors.html | 2 +- docs/index.html | 2 +- docs/news/index.html | 4 +- docs/pkgdown.yml | 6 +- docs/reference/EMLeditor-package.html | 2 +- docs/reference/Rplot001.png | Bin 1011 -> 0 bytes docs/reference/check_eml.html | 2 +- docs/reference/dot-get_unit_polygon.html | 128 ------------------ docs/reference/dot-get_user_input.html | 116 ---------------- docs/reference/dot-get_user_input3.html | 116 ---------------- docs/reference/dot-set_for_by_nps.html | 124 ----------------- docs/reference/dot-set_npspublisher.html | 128 ------------------ docs/reference/dot-set_version.html | 128 ------------------ docs/reference/get_abstract.html | 2 +- docs/reference/get_additional_info.html | 2 +- docs/reference/get_author_list.html | 2 +- docs/reference/get_begin_date.html | 2 +- docs/reference/get_citation.html | 2 +- docs/reference/get_content_units.html | 2 +- docs/reference/get_cui.html | 2 +- docs/reference/get_cui_code.html | 2 +- docs/reference/get_cui_marking.html | 2 +- docs/reference/get_doi.html | 2 +- docs/reference/get_drr_doi.html | 2 +- docs/reference/get_drr_title.html | 2 +- docs/reference/get_ds_id.html | 2 +- docs/reference/get_end_date.html | 2 +- docs/reference/get_file_info.html | 2 +- docs/reference/get_lit.html | 2 +- docs/reference/get_methods.html | 2 +- docs/reference/get_producing_units.html | 2 +- docs/reference/get_publisher.html | 2 +- docs/reference/get_title.html | 2 +- docs/reference/index.html | 26 +--- docs/reference/remove_datastore_files.html | 2 +- docs/reference/set_abstract.html | 2 +- docs/reference/set_additional_info.html | 2 +- docs/reference/set_content_units.html | 2 +- docs/reference/set_creator_orcids.html | 2 +- docs/reference/set_creator_order.html | 2 +- docs/reference/set_creator_orgs.html | 2 +- docs/reference/set_cui.html | 2 +- docs/reference/set_cui_code.html | 2 +- docs/reference/set_cui_marking.html | 2 +- docs/reference/set_data_urls.html | 2 +- docs/reference/set_datastore_doi.html | 2 +- docs/reference/set_doi.html | 2 +- docs/reference/set_drr.html | 2 +- docs/reference/set_int_rights.html | 2 +- docs/reference/set_language.html | 2 +- docs/reference/set_lit.html | 2 +- docs/reference/set_methods.html | 2 +- docs/reference/set_missing_data.html | 2 +- docs/reference/set_new_creator.html | 2 +- docs/reference/set_producing_units.html | 2 +- docs/reference/set_project.html | 2 +- docs/reference/set_protocol.html | 2 +- docs/reference/set_publisher.html | 2 +- docs/reference/set_title.html | 2 +- docs/reference/upload_data_package.html | 2 +- docs/reference/write_readme.html | 2 +- docs/sitemap.xml | 6 - man/dot-get_unit_polygon.Rd | 25 ---- man/dot-get_user_input.Rd | 19 --- man/dot-get_user_input3.Rd | 19 --- man/dot-set_for_by_nps.Rd | 22 --- man/dot-set_npspublisher.Rd | 25 ---- man/dot-set_version.Rd | 25 ---- 77 files changed, 66 insertions(+), 971 deletions(-) delete mode 100644 docs/reference/Rplot001.png delete mode 100644 docs/reference/dot-get_unit_polygon.html delete mode 100644 docs/reference/dot-get_user_input.html delete mode 100644 docs/reference/dot-get_user_input3.html delete mode 100644 docs/reference/dot-set_for_by_nps.html delete mode 100644 docs/reference/dot-set_npspublisher.html delete mode 100644 docs/reference/dot-set_version.html delete mode 100644 man/dot-get_unit_polygon.Rd delete mode 100644 man/dot-get_user_input.Rd delete mode 100644 man/dot-get_user_input3.Rd delete mode 100644 man/dot-set_for_by_nps.Rd delete mode 100644 man/dot-set_npspublisher.Rd delete mode 100644 man/dot-set_version.Rd diff --git a/docs/404.html b/docs/404.html index 2d9805a..16d3807 100644 --- a/docs/404.html +++ b/docs/404.html @@ -112,7 +112,7 @@

Page not found (404)

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 7d2b330..7b6f452 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -87,7 +87,7 @@

License

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 6dd5efe..c9618a6 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -118,7 +118,7 @@

Statement of Purpose -

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/articles/a01_prereqs.html b/docs/articles/a01_prereqs.html index cdf771a..4b35beb 100644 --- a/docs/articles/a01_prereqs.html +++ b/docs/articles/a01_prereqs.html @@ -177,7 +177,7 @@

A text editor

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/articles/a02_EML_creation_script.html b/docs/articles/a02_EML_creation_script.html index 2eeb3eb..cb0846d 100644 --- a/docs/articles/a02_EML_creation_script.html +++ b/docs/articles/a02_EML_creation_script.html @@ -768,7 +768,7 @@

Upload your data package

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/articles/a03_Template_edits.html b/docs/articles/a03_Template_edits.html index 6ac103d..cc94b6a 100644 --- a/docs/articles/a03_Template_edits.html +++ b/docs/articles/a03_Template_edits.html @@ -576,7 +576,7 @@

additional_info

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/articles/a04_Editing_fixing_eml.html b/docs/articles/a04_Editing_fixing_eml.html index 22917f1..07f1c9e 100644 --- a/docs/articles/a04_Editing_fixing_eml.html +++ b/docs/articles/a04_Editing_fixing_eml.html @@ -299,7 +299,7 @@

Write your edits to .xml

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/articles/a05_advanced_functionality.html b/docs/articles/a05_advanced_functionality.html index b5f13ce..456b6a0 100644 --- a/docs/articles/a05_advanced_functionality.html +++ b/docs/articles/a05_advanced_functionality.html @@ -229,7 +229,7 @@

View all functions

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/articles/index.html b/docs/articles/index.html index e2e5da8..a6b2b0c 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -92,7 +92,7 @@

All vignettes

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/authors.html b/docs/authors.html index 068f09a..d8073bb 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -118,7 +118,7 @@

Citation

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/index.html b/docs/index.html index d9647ad..7b96d59 100644 --- a/docs/index.html +++ b/docs/index.html @@ -192,7 +192,7 @@

Dev status

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/news/index.html b/docs/news/index.html index 2a8132c..e2ce017 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -125,7 +125,7 @@

2024-02-29

2024-02-22

  • Added function set_missing_data() which allows users to add missing data codes and missing data code definitions to metadata.
    • -
  • Added utility functions .get_user_input() and .get_user_input3(). Refactored all set_ class functions to use these sub-functions rather than readLines() to get user input.
    • +
  • Added utility functions .get_user_input() and .get_user_input3(). Refactored all set_ class functions to use these sub-functions rather than readLines() to get user input.

2024-02-13

@@ -394,7 +394,7 @@

EMLeditor 0.

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 22fbb17..98ea848 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,5 +1,5 @@ -pandoc: '3.2' -pkgdown: 2.1.1 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: a01_prereqs: a01_prereqs.html @@ -7,4 +7,4 @@ articles: 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:05Z diff --git a/docs/reference/EMLeditor-package.html b/docs/reference/EMLeditor-package.html index 337bcc6..bbe8492 100644 --- a/docs/reference/EMLeditor-package.html +++ b/docs/reference/EMLeditor-package.html @@ -101,7 +101,7 @@

Author

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png deleted file mode 100644 index 17a358060aed2a86950757bbd25c6f92c08c458f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1011 zcmeAS@N?(olHy`uVBq!ia0y~yV0-|=9Be?5+AI5}0x7m6Z+90U4Fo@(ch>_c&H|6f zVg?3oArNM~bhqvg0|WD9PZ!6KiaBo&GBN^{G%5UFpXcEKVvd5*5Eu=C0SJK)8A6*F U7`aXvEC5;V>FVdQ&MBb@00SN#Z2$lO diff --git a/docs/reference/check_eml.html b/docs/reference/check_eml.html index 3bdd793..9eb515c 100644 --- a/docs/reference/check_eml.html +++ b/docs/reference/check_eml.html @@ -110,7 +110,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/dot-get_unit_polygon.html b/docs/reference/dot-get_unit_polygon.html deleted file mode 100644 index 29392c0..0000000 --- a/docs/reference/dot-get_unit_polygon.html +++ /dev/null @@ -1,128 +0,0 @@ - -Get Park Unit Polygon — .get_unit_polygon • EMLeditor - - -
-
- - - -
-
-
-

Get Park Unit Polygon

- Source: R/utils.R - -
- -
-

.get_unit_polygon gets the polygon for a given park unit. The "polygon" pulled is a convexhull, the polygon is provided as in Well Known Text (WKT) format.

-
- -
- 
.get_unit_polygon(unit_code)
-
- -
-

Arguments

- - -
unit_code
-

a string (typically 4 characters) that is the park unit code.

- -
-
-

Value

-

well known text (wkt) convex hull of an NPS park unit.

-
-
-

Details

-

retrieves a geoJSON string for a polygon of a park unit from NPS Rest services. Note: This is not the official boundary (erm... ok then what is it?!?).

-
- -
-

Examples

- 
if (FALSE) { # \dontrun{
-poly <- .get_unit_polygon("BICY")
-} # }
-
-
-
- -
- - -
-

Developed by Robert Baker, Judd Patterson.

-
- -
-

Site built with pkgdown 2.1.1.

-
- -
- - - - - - - - diff --git a/docs/reference/dot-get_user_input.html b/docs/reference/dot-get_user_input.html deleted file mode 100644 index a5f949f..0000000 --- a/docs/reference/dot-get_user_input.html +++ /dev/null @@ -1,116 +0,0 @@ - -Get Binary User Input — .get_user_input • EMLeditor - - -
-
- - - -
-
-
-

Get Binary User Input

- Source: R/utils.R - -
- -
-

Prompts for, gets, and returns binary user input (1 or 2)

-
- -
- 
.get_user_input()
-
- -
-

Value

-

Factor. 1 or 2.

-
- -
-

Examples

- 
if (FALSE) { # \dontrun{
-var1 <- .get_user_input()
-} # }
-
-
-
- -
- - -
-

Developed by Robert Baker, Judd Patterson.

-
- -
-

Site built with pkgdown 2.1.1.

-
- -
- - - - - - - - diff --git a/docs/reference/dot-get_user_input3.html b/docs/reference/dot-get_user_input3.html deleted file mode 100644 index 73bc1db..0000000 --- a/docs/reference/dot-get_user_input3.html +++ /dev/null @@ -1,116 +0,0 @@ - -Get open ended user input — .get_user_input3 • EMLeditor - - -
-
- - - -
-
-
-

Get open ended user input

- Source: R/utils.R - -
- -
-

Does not prompt for user input. Takes any user input supplied and returns it.

-
- -
- 
.get_user_input3()
-
- -
-

Value

-

character, typically 1, 2, or 3 but could be any character string.

-
- -
-

Examples

- 
if (FALSE) { # \dontrun{
-var1 <- .get_user_input3()
-} # }
-
-
-
- -
- - -
-

Developed by Robert Baker, Judd Patterson.

-
- -
-

Site built with pkgdown 2.1.1.

-
- -
- - - - - - - - diff --git a/docs/reference/dot-set_for_by_nps.html b/docs/reference/dot-set_for_by_nps.html deleted file mode 100644 index f487ef1..0000000 --- a/docs/reference/dot-set_for_by_nps.html +++ /dev/null @@ -1,124 +0,0 @@ - -Set "For or By" NPS — .set_for_by_nps • EMLeditor - - -
-
- - - -
-
-
-

Set "For or By" NPS

- Source: R/utils.R - -
- -
-

.set_for_by_nps adds an element to additionalMetadata with For or By NPS set to TRUE and a second element agencyOriginated set to "NPS" with the understanding that all data products created for or by the NPS have NPS as the originating agency.

-
- -
- 
.set_for_by_nps(eml_object)
-
- -
-

Arguments

- - -
eml_object
-

is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(, from="xml").

- -
-
-

Value

-

eml_object

-
- -
-

Examples

- 
if (FALSE) { # \dontrun{
-.set_for_by_nps(eml_object)
-} # }
-
-
-
- -
- - -
-

Developed by Robert Baker, Judd Patterson.

-
- -
-

Site built with pkgdown 2.1.1.

-
- -
- - - - - - - - diff --git a/docs/reference/dot-set_npspublisher.html b/docs/reference/dot-set_npspublisher.html deleted file mode 100644 index 1990845..0000000 --- a/docs/reference/dot-set_npspublisher.html +++ /dev/null @@ -1,128 +0,0 @@ - -inject NPS Publisher info into metadata — .set_npspublisher • EMLeditor - - -
-
- - - -
-
-
-

inject NPS Publisher info into metadata

- Source: R/utils.R - -
- -
-

.set_npspublisher injects static NPS-specific publisher info into eml documents. Calls the sub-function set.forOrByNPS, which adds an additionalMetadata element with for or by NPS = TRUE.

-
- -
- 
.set_npspublisher(eml_object)
-
- -
-

Arguments

- - -
eml_object
-

is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(, from="xml").

- -
-
-

Value

-

eml_object

-
-
-

Details

-

checks to see if the publisher element exists, and if not injects NPS-specific info into EML such as publisher, publication location, and ROR id - the types of things that will be the same for all NPS data or non-data publications and do not require user input. This function will be embedded in all set. and write. class functions (and get. functions?).

-
- -
-

Examples

- 
if (FALSE) { # \dontrun{
-.set_npspublisher(eml_object)
-} # }
-
-
-
- -
- - -
-

Developed by Robert Baker, Judd Patterson.

-
- -
-

Site built with pkgdown 2.1.1.

-
- -
- - - - - - - - diff --git a/docs/reference/dot-set_version.html b/docs/reference/dot-set_version.html deleted file mode 100644 index a046554..0000000 --- a/docs/reference/dot-set_version.html +++ /dev/null @@ -1,128 +0,0 @@ - -Add/update EMLeditor version — .set_version • EMLeditor - - -
-
- - - -
-
-
-

Add/update EMLeditor version

- Source: R/utils.R - -
- -
-

.set_version adds the current version of EMLeditor to the EML document.

-
- -
- 
.set_version(eml_object)
-
- -
-

Arguments

- - -
eml_object
-

is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(, from="xml").

- -
-
-

Value

-

eml_object

-
-
-

Details

-

.set_version adds the current version of EMLeditor to the metadata, specifically in the "additionalMetadata" element

-
- -
-

Examples

- 
if (FALSE) { # \dontrun{
-.set_version(eml_object)
-} # }
-
-
-
- -
- - -
-

Developed by Robert Baker, Judd Patterson.

-
- -
-

Site built with pkgdown 2.1.1.

-
- -
- - - - - - - - diff --git a/docs/reference/get_abstract.html b/docs/reference/get_abstract.html index f059085..0020394 100644 --- a/docs/reference/get_abstract.html +++ b/docs/reference/get_abstract.html @@ -115,7 +115,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_additional_info.html b/docs/reference/get_additional_info.html index 6a24818..b749e1c 100644 --- a/docs/reference/get_additional_info.html +++ b/docs/reference/get_additional_info.html @@ -110,7 +110,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_author_list.html b/docs/reference/get_author_list.html index a045cbc..15df561 100644 --- a/docs/reference/get_author_list.html +++ b/docs/reference/get_author_list.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_begin_date.html b/docs/reference/get_begin_date.html index 7fc91e1..429bf5f 100644 --- a/docs/reference/get_begin_date.html +++ b/docs/reference/get_begin_date.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_citation.html b/docs/reference/get_citation.html index a3b05b2..e856a8f 100644 --- a/docs/reference/get_citation.html +++ b/docs/reference/get_citation.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_content_units.html b/docs/reference/get_content_units.html index 4b405bf..97b53ec 100644 --- a/docs/reference/get_content_units.html +++ b/docs/reference/get_content_units.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_cui.html b/docs/reference/get_cui.html index 3d2c337..d1c22ef 100644 --- a/docs/reference/get_cui.html +++ b/docs/reference/get_cui.html @@ -116,7 +116,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_cui_code.html b/docs/reference/get_cui_code.html index 60a24d9..1b95620 100644 --- a/docs/reference/get_cui_code.html +++ b/docs/reference/get_cui_code.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_cui_marking.html b/docs/reference/get_cui_marking.html index 86633e0..e9b8212 100644 --- a/docs/reference/get_cui_marking.html +++ b/docs/reference/get_cui_marking.html @@ -115,7 +115,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_doi.html b/docs/reference/get_doi.html index ea6745d..aa17149 100644 --- a/docs/reference/get_doi.html +++ b/docs/reference/get_doi.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_drr_doi.html b/docs/reference/get_drr_doi.html index c18fe5c..06f937e 100644 --- a/docs/reference/get_drr_doi.html +++ b/docs/reference/get_drr_doi.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_drr_title.html b/docs/reference/get_drr_title.html index f4441ef..8c040df 100644 --- a/docs/reference/get_drr_title.html +++ b/docs/reference/get_drr_title.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_ds_id.html b/docs/reference/get_ds_id.html index 5e9b0ff..11d6457 100644 --- a/docs/reference/get_ds_id.html +++ b/docs/reference/get_ds_id.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_end_date.html b/docs/reference/get_end_date.html index d32b419..28bf264 100644 --- a/docs/reference/get_end_date.html +++ b/docs/reference/get_end_date.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_file_info.html b/docs/reference/get_file_info.html index 0f5eef8..ffb0105 100644 --- a/docs/reference/get_file_info.html +++ b/docs/reference/get_file_info.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_lit.html b/docs/reference/get_lit.html index df22560..c832f9e 100644 --- a/docs/reference/get_lit.html +++ b/docs/reference/get_lit.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_methods.html b/docs/reference/get_methods.html index 688840f..8281388 100644 --- a/docs/reference/get_methods.html +++ b/docs/reference/get_methods.html @@ -112,7 +112,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_producing_units.html b/docs/reference/get_producing_units.html index 6147923..f485d13 100644 --- a/docs/reference/get_producing_units.html +++ b/docs/reference/get_producing_units.html @@ -110,7 +110,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_publisher.html b/docs/reference/get_publisher.html index c403d6b..7e22be7 100644 --- a/docs/reference/get_publisher.html +++ b/docs/reference/get_publisher.html @@ -110,7 +110,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/get_title.html b/docs/reference/get_title.html index 4bd2af0..41aebf8 100644 --- a/docs/reference/get_title.html +++ b/docs/reference/get_title.html @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/index.html b/docs/reference/index.html index 662a9ee..d5b3fd3 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -76,30 +76,6 @@

All functions check_eml()

Run checks on EML

- -

.get_unit_polygon()

- -

Get Park Unit Polygon

- -

.get_user_input()

- -

Get Binary User Input

- -

.get_user_input3()

- -

Get open ended user input

- -

.set_for_by_nps()

- -

Set "For or By" NPS

- -

.set_npspublisher()

- -

inject NPS Publisher info into metadata

- -

.set_version()

- -

Add/update EMLeditor version

get_abstract()

@@ -301,7 +277,7 @@

All functions
-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/remove_datastore_files.html b/docs/reference/remove_datastore_files.html index 3ce4ee3..bd96771 100644 --- a/docs/reference/remove_datastore_files.html +++ b/docs/reference/remove_datastore_files.html @@ -119,7 +119,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_abstract.html b/docs/reference/set_abstract.html index f2178ea..60c0cd0 100644 --- a/docs/reference/set_abstract.html +++ b/docs/reference/set_abstract.html @@ -126,7 +126,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_additional_info.html b/docs/reference/set_additional_info.html index f570eaf..e506faf 100644 --- a/docs/reference/set_additional_info.html +++ b/docs/reference/set_additional_info.html @@ -128,7 +128,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_content_units.html b/docs/reference/set_content_units.html index b2b26e3..be0e4ad 100644 --- a/docs/reference/set_content_units.html +++ b/docs/reference/set_content_units.html @@ -127,7 +127,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_creator_orcids.html b/docs/reference/set_creator_orcids.html index 7712263..1f2c5ca 100644 --- a/docs/reference/set_creator_orcids.html +++ b/docs/reference/set_creator_orcids.html @@ -131,7 +131,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_creator_order.html b/docs/reference/set_creator_order.html index 030f6af..3d8cfc5 100644 --- a/docs/reference/set_creator_order.html +++ b/docs/reference/set_creator_order.html @@ -134,7 +134,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_creator_orgs.html b/docs/reference/set_creator_orgs.html index f8323a7..dfc7eed 100644 --- a/docs/reference/set_creator_orgs.html +++ b/docs/reference/set_creator_orgs.html @@ -158,7 +158,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_cui.html b/docs/reference/set_cui.html index 5eda66e..90a04b9 100644 --- a/docs/reference/set_cui.html +++ b/docs/reference/set_cui.html @@ -138,7 +138,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_cui_code.html b/docs/reference/set_cui_code.html index 477f0b1..268c4cb 100644 --- a/docs/reference/set_cui_code.html +++ b/docs/reference/set_cui_code.html @@ -137,7 +137,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_cui_marking.html b/docs/reference/set_cui_marking.html index a89b784..eb7c3f5 100644 --- a/docs/reference/set_cui_marking.html +++ b/docs/reference/set_cui_marking.html @@ -142,7 +142,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_data_urls.html b/docs/reference/set_data_urls.html index 6f4481b..fff9d13 100644 --- a/docs/reference/set_data_urls.html +++ b/docs/reference/set_data_urls.html @@ -129,7 +129,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_datastore_doi.html b/docs/reference/set_datastore_doi.html index 51659bb..0d115f2 100644 --- a/docs/reference/set_datastore_doi.html +++ b/docs/reference/set_datastore_doi.html @@ -129,7 +129,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_doi.html b/docs/reference/set_doi.html index 2283c54..74520a8 100644 --- a/docs/reference/set_doi.html +++ b/docs/reference/set_doi.html @@ -128,7 +128,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_drr.html b/docs/reference/set_drr.html index 6d1224a..c775cc8 100644 --- a/docs/reference/set_drr.html +++ b/docs/reference/set_drr.html @@ -142,7 +142,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_int_rights.html b/docs/reference/set_int_rights.html index ae086b8..14dab57 100644 --- a/docs/reference/set_int_rights.html +++ b/docs/reference/set_int_rights.html @@ -132,7 +132,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_language.html b/docs/reference/set_language.html index d0e474e..86f6c2d 100644 --- a/docs/reference/set_language.html +++ b/docs/reference/set_language.html @@ -128,7 +128,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_lit.html b/docs/reference/set_lit.html index 2a5e216..73ce324 100644 --- a/docs/reference/set_lit.html +++ b/docs/reference/set_lit.html @@ -128,7 +128,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_methods.html b/docs/reference/set_methods.html index b6122b1..5100f6a 100644 --- a/docs/reference/set_methods.html +++ b/docs/reference/set_methods.html @@ -127,7 +127,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_missing_data.html b/docs/reference/set_missing_data.html index a6c1ff2..9d2a167 100644 --- a/docs/reference/set_missing_data.html +++ b/docs/reference/set_missing_data.html @@ -181,7 +181,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_new_creator.html b/docs/reference/set_new_creator.html index f335154..c1f2658 100644 --- a/docs/reference/set_new_creator.html +++ b/docs/reference/set_new_creator.html @@ -157,7 +157,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_producing_units.html b/docs/reference/set_producing_units.html index 7148f9e..619d7bd 100644 --- a/docs/reference/set_producing_units.html +++ b/docs/reference/set_producing_units.html @@ -129,7 +129,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_project.html b/docs/reference/set_project.html index 2a7ca2f..26399c4 100644 --- a/docs/reference/set_project.html +++ b/docs/reference/set_project.html @@ -138,7 +138,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_protocol.html b/docs/reference/set_protocol.html index 08f02e9..1629e2c 100644 --- a/docs/reference/set_protocol.html +++ b/docs/reference/set_protocol.html @@ -135,7 +135,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_publisher.html b/docs/reference/set_publisher.html index a7866bb..1e1c288 100644 --- a/docs/reference/set_publisher.html +++ b/docs/reference/set_publisher.html @@ -184,7 +184,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/set_title.html b/docs/reference/set_title.html index 4127777..2434520 100644 --- a/docs/reference/set_title.html +++ b/docs/reference/set_title.html @@ -127,7 +127,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/upload_data_package.html b/docs/reference/upload_data_package.html index dfb7ab4..bcda87d 100644 --- a/docs/reference/upload_data_package.html +++ b/docs/reference/upload_data_package.html @@ -127,7 +127,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/reference/write_readme.html b/docs/reference/write_readme.html index 92af173..7f21780 100644 --- a/docs/reference/write_readme.html +++ b/docs/reference/write_readme.html @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.1.1.

+

Site built with pkgdown 2.1.0.

diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 63506e7..76fc0f4 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -12,12 +12,6 @@ /LICENSE.html /news/index.html /reference/check_eml.html -/reference/dot-get_unit_polygon.html -/reference/dot-get_user_input.html -/reference/dot-get_user_input3.html -/reference/dot-set_for_by_nps.html -/reference/dot-set_npspublisher.html -/reference/dot-set_version.html /reference/EMLeditor-package.html /reference/get_abstract.html /reference/get_additional_info.html diff --git a/man/dot-get_unit_polygon.Rd b/man/dot-get_unit_polygon.Rd deleted file mode 100644 index 0de81ba..0000000 --- a/man/dot-get_unit_polygon.Rd +++ /dev/null @@ -1,25 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{.get_unit_polygon} -\alias{.get_unit_polygon} -\title{Get Park Unit Polygon} -\usage{ -.get_unit_polygon(unit_code) -} -\arguments{ -\item{unit_code}{a string (typically 4 characters) that is the park unit code.} -} -\value{ -well known text (wkt) convex hull of an NPS park unit. -} -\description{ -.get_unit_polygon gets the polygon for a given park unit. The "polygon" pulled is a convexhull, the polygon is provided as in Well Known Text (WKT) format. -} -\details{ -retrieves a geoJSON string for a polygon of a park unit from NPS Rest services. Note: This is not the official boundary (erm... ok then what is it?!?). -} -\examples{ -\dontrun{ -poly <- .get_unit_polygon("BICY") -} -} diff --git a/man/dot-get_user_input.Rd b/man/dot-get_user_input.Rd deleted file mode 100644 index 9560c1d..0000000 --- a/man/dot-get_user_input.Rd +++ /dev/null @@ -1,19 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{.get_user_input} -\alias{.get_user_input} -\title{Get Binary User Input} -\usage{ -.get_user_input() -} -\value{ -Factor. 1 or 2. -} -\description{ -Prompts for, gets, and returns binary user input (1 or 2) -} -\examples{ -\dontrun{ -var1 <- .get_user_input() -} -} diff --git a/man/dot-get_user_input3.Rd b/man/dot-get_user_input3.Rd deleted file mode 100644 index 3d461fc..0000000 --- a/man/dot-get_user_input3.Rd +++ /dev/null @@ -1,19 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{.get_user_input3} -\alias{.get_user_input3} -\title{Get open ended user input} -\usage{ -.get_user_input3() -} -\value{ -character, typically 1, 2, or 3 but could be any character string. -} -\description{ -Does not prompt for user input. Takes any user input supplied and returns it. -} -\examples{ -\dontrun{ -var1 <- .get_user_input3() -} -} diff --git a/man/dot-set_for_by_nps.Rd b/man/dot-set_for_by_nps.Rd deleted file mode 100644 index e40eec3..0000000 --- a/man/dot-set_for_by_nps.Rd +++ /dev/null @@ -1,22 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{.set_for_by_nps} -\alias{.set_for_by_nps} -\title{Set "For or By" NPS} -\usage{ -.set_for_by_nps(eml_object) -} -\arguments{ -\item{eml_object}{is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(\if{html}{\out{}}, from="xml").} -} -\value{ -eml_object -} -\description{ -.set_for_by_nps adds an element to additionalMetadata with For or By NPS set to TRUE and a second element agencyOriginated set to "NPS" with the understanding that all data products created for or by the NPS have NPS as the originating agency. -} -\examples{ -\dontrun{ -.set_for_by_nps(eml_object) -} -} diff --git a/man/dot-set_npspublisher.Rd b/man/dot-set_npspublisher.Rd deleted file mode 100644 index 67183fd..0000000 --- a/man/dot-set_npspublisher.Rd +++ /dev/null @@ -1,25 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{.set_npspublisher} -\alias{.set_npspublisher} -\title{inject NPS Publisher info into metadata} -\usage{ -.set_npspublisher(eml_object) -} -\arguments{ -\item{eml_object}{is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(\if{html}{\out{}}, from="xml").} -} -\value{ -eml_object -} -\description{ -.set_npspublisher injects static NPS-specific publisher info into eml documents. Calls the sub-function set.forOrByNPS, which adds an additionalMetadata element with for or by NPS = TRUE. -} -\details{ -checks to see if the publisher element exists, and if not injects NPS-specific info into EML such as publisher, publication location, and ROR id - the types of things that will be the same for all NPS data or non-data publications and do not require user input. This function will be embedded in all set. and write. class functions (and get. functions?). -} -\examples{ -\dontrun{ -.set_npspublisher(eml_object) -} -} diff --git a/man/dot-set_version.Rd b/man/dot-set_version.Rd deleted file mode 100644 index dd703a8..0000000 --- a/man/dot-set_version.Rd +++ /dev/null @@ -1,25 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R -\name{.set_version} -\alias{.set_version} -\title{Add/update EMLeditor version} -\usage{ -.set_version(eml_object) -} -\arguments{ -\item{eml_object}{is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(\if{html}{\out{}}, from="xml").} -} -\value{ -eml_object -} -\description{ -.set_version adds the current version of EMLeditor to the EML document. -} -\details{ -.set_version adds the current version of EMLeditor to the metadata, specifically in the "additionalMetadata" element -} -\examples{ -\dontrun{ -.set_version(eml_object) -} -} From bad3f1bbf789d5fae9b4ba33097a84365810059e Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Wed, 23 Oct 2024 08:31:26 -0600 Subject: [PATCH 5/5] pkgdown::build_site_github_pages() --- docs/news/index.html | 9 +++++++++ docs/pkgdown.yml | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/news/index.html b/docs/news/index.html index e2ce017..4c6de01 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -69,6 +69,15 @@

Changelog

Source: NEWS.md +
+

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

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 98ea848..a9f2cfb 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -7,4 +7,4 @@ articles: 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-23T14:05Z +last_built: 2024-10-23T14:29Z