Merge pull request DOI-NPS#193 from RobLBaker/main

add function to support removal of arcticdatautils dependency across NPSdataverse

Author: RobLBaker

NAMESPACE

@@ -14,6 +14,7 @@ export(get_doi)
 export(get_drr_doi)
 export(get_drr_title)
 export(get_ds_id)
+export(get_eml_simple)
 export(get_end_date)
 export(get_file_info)
 export(get_lit)

NEWS.md

@@ -1,4 +1,7 @@
 # EMLeditor v1.0.1 (under development)
+## 2025-04-11
+  * add `get_eml_simple` function and associated unit test.
+  
 ## 2025-04-09
   * update `set_data_urls` to set dataset urls in addition to dataTable urls. `set_data_urls` now adds a function = "information" tag to urls because they do not lead to direct file download links. It will overwrite all function = "download" tags added by ezEML.
   * update `set_data_urls` unit tests; add test for function = "information".

R/getEMLfunctions.R

@@ -1,3 +1,24 @@
+#' Returns a simple list of eml elements
+#'
+#' This function wraps EML::get_eml and returns the requested object in a much simpler format. It works best with eml elements that do not have child elements.
+#'
+#' @param eml_object is an R object imported (typically from an EML-formatted .xml file) using EmL::read_eml(<filename>, from="xml").
+#' @param eml_element is a string indicating the element within the eml_object that should be accessed and returned.
+#'
+#' @returns a list of values
+#' @export
+#' @examples
+#' \dontrun{
+#' get_eml_simple(eml_object, "geographicDescription")
+#' }
+get_eml_simple <- function(eml_object, eml_element){
+  out <- EML::eml_get(eml_object, eml_element, from = "list")
+  out$`@context` <- NULL
+  attributes(out) <- NULL
+  out <- unlist(out)
+  return(out)
+}
+
 #' returns the first date
 #'
 #' @description get_begin_date returns the date of the earliest data point in the data package

docs/news/index.html

@@ -7,7 +7,7 @@ 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: 2025-04-09T17:13Z
+last_built: 2025-04-11T22:09Z
 urls:
   reference: https://nationalparkservice.github.io/EMLeditor/reference
   article: https://nationalparkservice.github.io/EMLeditor/articles

docs/pkgdown.yml

@@ -26,6 +26,7 @@
 <url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_drr_doi.html</loc></url>
 <url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_drr_title.html</loc></url>
 <url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_ds_id.html</loc></url>
+<url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_eml_simple.html</loc></url>
 <url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_end_date.html</loc></url>
 <url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_file_info.html</loc></url>
 <url><loc>https://nationalparkservice.github.io/EMLeditor/reference/get_lit.html</loc></url>

docs/reference/index.html

@@ -8,6 +8,13 @@ BICY_EMLed_meta <- EML::read_eml(testthat::test_path("good",
 return_val_2 <- function() {2}
 return_val_1 <- function() {1}
 
+# ---- get_eml_simple ----
+
+test_that("get_eml_simple returns a simple vector of values", {
+  simple_list <- get_eml_simple(BICY_EMLed_meta, "geographicDescription")
+  expect_equal(simple_list, c("NPS Unit Connections: BICY", "BICY"))
+})
+
 # ---- get_begin_date ----
 
 test_that("get_begin_date gets the beginning date of EML document", {