as.unit: Convert a String to a Unit

View source: R/units.R

as.unitR Documentation

Convert a String to a Unit

Description

This function is not presently used by any oce functions, and is provided as a convenience function for users.

Usage

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

Arguments

u

A character string indicating a variable name. The following names are recognized: "DBAR", "IPTS-68", "ITS-90", "PSS-78", and "UMOL/KG". All other names yield a return value equal to the value of the default argument.

default

A default to be used for the return value, if u is not a recognized string.

Value

A list with elements unit, an expression(), and scale, a string.

Examples

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

oce documentation built on July 6, 2022, 1:06 a.m.