get_unit_id: get_unit_id

In EML: Read and Write Ecological Metadata Language Files

get_unit_id

Description

A function to assist with getting valid EML unit ids (see examples). Warning: ensure returned unit is equivalent to input unit (for example "pH" will return "picohenry" which may or may not be equivalent to the input unit "pH").

Usage

get_unit_id(input_units, eml_version = emld::eml_version())

Arguments

input_units	(character|vector) input units that needs valid EML unit ids
eml_version	(character) the eml schema version desired (there is a change in the way eml units are named from eml-2.1.1 to eml-2.2.0)

Value

(character) A valid EML unit id. If no valid EML unit id can be found, the function will output a warning, along with a preformatted custom unit id.

Examples

## Not run: 
# The following all return the same id
get_unit_id("kilometersPerSquareSecond")
get_unit_id("kilometerPerSecondSquared")
get_unit_id("Kilometers per seconds squared")
get_unit_id("km/s^2")
get_unit_id("km s-2")
get_unit_id("s-2 /     kilometers-1") # this works but is not advised

## End(Not run)

EML documentation built on April 29, 2022, 1:06 a.m.