EVOLUTION-MANAGER
Edit File: install_symbolic_unit.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Define new symbolic units</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for install_symbolic_unit {units}"><tr><td>install_symbolic_unit {units}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Define new symbolic units</h2> <h3>Description</h3> <p>Adding a symbolic unit allows it to be used in <code>as_units</code>, <code>make_units</code> and <code>set_units</code>. No installation is performed if the unit is already known by udunits. </p> <h3>Usage</h3> <pre> install_symbolic_unit(name, warn = TRUE, dimensionless = TRUE) remove_symbolic_unit(name) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>name</code></td> <td> <p>a length 1 character vector that is the unit name or symbol.</p> </td></tr> <tr valign="top"><td><code>warn</code></td> <td> <p>warns if the supplied unit symbol is already a valid unit symbol recognized by udunits.</p> </td></tr> <tr valign="top"><td><code>dimensionless</code></td> <td> <p>logical; if <code>TRUE</code>, a new dimensionless unit is created, if <code>FALSE</code> a new base unit is created. Dimensionless units are convertible to other dimensionless units (such as <code>rad</code>), new base units are not convertible to other existing units.</p> </td></tr> </table> <h3>Details</h3> <p><code>install_symbolic_unit</code> installs a new dimensionless unit; these are directly compatible to any other dimensionless unit. To install a new unit that is a scaled or shifted version of an existing unit, use <code>install_conversion_constant</code> or <code>install_conversion_offset</code> directly. </p> <h3>See Also</h3> <p><code><a href="install_conversion_constant.html">install_conversion_constant</a></code>, <code><a href="install_conversion_constant.html">install_conversion_offset</a></code> </p> <h3>Examples</h3> <pre> install_symbolic_unit("person") set_units(1, rad) + set_units(1, person) # that is how dimensionless units work! </pre> <hr /><div style="text-align: center;">[Package <em>units</em> version 0.6-7 <a href="00Index.html">Index</a>]</div> </body></html>