which_in_eml: Search through EMLs

View source: R/deprecated.R

which_in_emlR Documentation

Search through EMLs

Description

\Sexpr[results=rd, stage=render]{lifecycle::badge("deprecated")}

Usage

which_in_eml(doc, element, test)

Arguments

doc

(list) An EML object.

element

(character) Element to evaluate.

test

(function/character) A function to evaluate (see examples). If test is a character, will evaluate if element == test (see example 1).

Details

please use eml_get_simple() and which() together instead

This function returns indices within an EML list that contain an instance where test == TRUE. See examples for more information.

Author(s)

Mitchell Maier mitchell.maier@gmail.com

Examples

## Not run: 
# Question: Which creators have a surName "Smith"?
n <- which_in_eml(eml$dataset$creator, "surName", "Smith")
# Answer: eml$dataset$creator[n]

# Question: Which dataTables have an entityName that begins with "2016"
n <- which_in_eml(eml$dataset$dataTable, "entityName", function(x) {grepl("^2016", x)})
# Answer: eml$dataset$dataTable[n]

# Question: Which attributes in dataTable[[1]] have a numberType "natural"?
n <- which_in_eml(eml$dataset$dataTable[[1]]$attributeList$attribute, "numberType", "natural")
# Answer: eml$dataset$dataTable[[1]]$attributeList$attribute[n]

#' # Question: Which dataTables have at least one attribute with a numberType "natural"?
n <- which_in_eml(eml$dataset$dataTable, "numberType", function(x) {"natural" %in% x})
# Answer: eml$dataset$dataTable[n]

## End(Not run)

NCEAS/arcticdatautils documentation built on Aug. 28, 2023, 12:10 p.m.