EVOLUTION-MANAGER
Edit File: valid_udunits.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: Get information about valid 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 valid_udunits {units}"><tr><td>valid_udunits {units}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Get information about valid units</h2> <h3>Description</h3> <p>The returned dataframe is constructed at runtime by reading the xml database that powers unit conversion in [package:udunits2]. Inspect this dataframe to determine what inputs are accepted by <code>as_units</code> (and the other functions it powers: <code>as_units</code> , <code>set_units</code> , <code>units<-</code>). </p> <h3>Usage</h3> <pre> valid_udunits(quiet = FALSE) valid_udunits_prefixes(quiet = FALSE) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>quiet</code></td> <td> <p>logical, defaults <code>TRUE</code> to give a message about the location of the udunits database being read.</p> </td></tr> </table> <h3>Details</h3> <p>Any entry listed under <code>symbol</code> , <code>symbol_aliases</code> , <code> name_singular</code> , <code>name_singular_aliases</code> , <code>name_plural</code> , or <code>name_plural_aliases</code> is valid. Additionally, any entry under <code>symbol</code> or <code>symbol_aliases</code> may can also contain a valid prefix, as specified by <code>valid_udunits_prefixes()</code> . </p> <p>Note, this is primarily intended for interactive use, the exact format of the returned dataframe may change in the future. </p> <h3>Value</h3> <p>a data frame with columns <code>symbol</code> , <code>symbol_aliases</code> , <code>name_singular</code> , <code>name_singular_aliases</code> , <code>name_plural</code> , or <code>name_plural_aliases</code> , <code>def</code> , <code>definition</code> , <code>comment</code> , <code>dimensionless</code> and <code>source_xml</code> </p> <h3>Examples</h3> <pre> if (requireNamespace("xml2", quietly = TRUE)) { valid_udunits() valid_udunits_prefixes() if(interactive()) View(valid_udunits()) } </pre> <hr /><div style="text-align: center;">[Package <em>units</em> version 0.6-7 <a href="00Index.html">Index</a>]</div> </body></html>