as.unit: Convert a String to a Unit

In dankelley/oce: Analysis of Oceanographic Data

Convert a String to a Unit

Description

This converts strings to unit objects. It is designed mainly for use within various functions in the package, not for the end user. Therefore, the documentation does not give a full listing; for that, developers should examine the tests/test_that/test_units.R file. Developers who wish to add new entries are asked to follow the conventions in this file, with regard to regular expressions, spaces between tokens, etc., and also to add tests for whatever they add.

Usage

as.unit(u, default = list(unit = expression(), scale = ""))

Arguments

u	a character string indicating a unit. Case is ignored, so that e.g. "dbar" and "DBAR" yield equal results. Many common notations are recognized, e.g. kg/m^3 and ⁠kg m-3⁠ for density, etc.
default	a default to be used for the return value, if u is not a recognized string. Setting this to NULL is a good way to discover whether a given value of u is recognized as a unit by this function, as opposed to something (like a conductivity ratio) that simply has no unit.

Value

if as.unit recognizes u as unit, then it returns a list with elements unit, which is an expression(), and scale, which is a character value. That is also the case if it does not recognize u, and if default is not specified. However, if u is not recognized, and if default is provided by the user, then as.unit returns the provided value of default.

Author(s)

Dan Kelley

Examples

as.unit("DBAR")
as.unit("IPTS-68")
as.unit("ITS-90")
as.unit("PSS-78")
as.unit("UMOL/KG")

dankelley/oce documentation built on March 1, 2025, 6:36 p.m.