validMetadataUnits: Check whether these units are acceptable (without...

In USGS-R/loadflex: Models and Tools for Watershed Flux Estimates

Check whether these units are acceptable (without translation) for inclusion in metadata

Description

Check whether these units are acceptable (without translation) for inclusion in metadata

Usage

validMetadataUnits(unitstr, unit.type = c("ANY", "flow.units",
  "conc.units", "load.units", "load.rate.units", "basin.area.units"))

Arguments

unitstr	A string representing units (just one bundle at a time, please)
unit.type	string. accepts "ANY","flow.units","conc.units","load.units", or "load.rate.units"
type	A string describing the type of units desired

Value

logical. TRUE if valid for that unit type, FALSE otherwise

Examples

validMetadataUnits("colonies d^-1") # TRUE
validMetadataUnits("m^3 s^-1", unit.type="ANY") # TRUE
validMetadataUnits("nonsensical") # FALSE
validMetadataUnits("g", unit.type="load.units") # TRUE
validMetadataUnits("g", unit.type="flow.units") # FALSE

USGS-R/loadflex documentation built on Dec. 10, 2024, 10:35 p.m.