CFLabel

<p>This class represent CF labels, i.e. an NC variable of character
type that provides a textual label for a discrete or general numeric axis.
See also CFAxisCharacter, which is an axis with character labels.</p>

Network Common Data Form ('netCDF') files are widely used for
scientific data. Library-level access in R is provided through packages
'RNetCDF' and 'ncdf4'. Package 'ncdfCF' is built on top of 'RNetCDF' and
makes the data and its attributes available as a set of R6 classes that are
informed by the Climate and Forecasting Metadata Conventions. Access to the
data uses standard R subsetting operators and common function forms.

Patrick Van Laake

ncdfCF

Easy Access to NetCDF Files with CF Metadata Conventions

CFLabel function

<p><code>ncdfCF::CFObject</code> -&gt; <code>CFLabel</code></p>

Super class

<p><div class="r6-fields"></div></p><dl>
<dt><code>NCdim</code></dt>
<dd><p>The NCDimension that stores the netCDF dimension details.</p></dd><p></p><p>
<dt><code>values</code></dt>
<dd><p>The label values, a character vector.</p></dd></p><p>
</p></dl><p></p>

Public fields

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>friendlyClassName</code></dt>
<dd><p>(read-only) A nice description of the class.</p></dd><p></p><p>
<dt><code>length</code></dt>
<dd><p>(read-only) The number of labels.</p></dd></p><p>
<dt><code>dimid</code></dt>
<dd><p>(read-only) The netCDF dimension id of this label.</p></dd></p><p>
</p></dl><p></p>

Active bindings


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/CFLabel%24new()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::CFLabel$new()"><code>CFLabel$new()</code></a></p></li>
<li><p><a href="/link/CFLabel%24clone()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::CFLabel$clone()"><code>CFLabel$clone()</code></a></p></li>
</ul></p><p></p></div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="append_attribute"><a href="/link/ncdfCF%3A%3ACFObject%24append_attribute()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::ncdfCF::CFObject$append_attribute()"><code>ncdfCF::CFObject$append_attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="attribute"><a href="/link/ncdfCF%3A%3ACFObject%24attribute()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::ncdfCF::CFObject$attribute()"><code>ncdfCF::CFObject$attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="delete_attribute"><a href="/link/ncdfCF%3A%3ACFObject%24delete_attribute()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::ncdfCF::CFObject$delete_attribute()"><code>ncdfCF::CFObject$delete_attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="print_attributes"><a href="/link/ncdfCF%3A%3ACFObject%24print_attributes()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::ncdfCF::CFObject$print_attributes()"><code>ncdfCF::CFObject$print_attributes()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="set_attribute"><a href="/link/ncdfCF%3A%3ACFObject%24set_attribute()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::ncdfCF::CFObject$set_attribute()"><code>ncdfCF::CFObject$set_attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="write_attributes"><a href="/link/ncdfCF%3A%3ACFObject%24write_attributes()?package=ncdfCF&version=0.4.0" data-mini-rdoc="ncdfCF::ncdfCF::CFObject$write_attributes()"><code>ncdfCF::CFObject$write_attributes()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-CFLabel-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new instance of this class.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>CFLabel$new(grp, nc_var, nc_dim, values)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>grp</code></dt>
<dd><p>The group that contains the netCDF variable.</p></dd></dl></div></p><p>
<dt><code>nc_var</code></dt>
<dd><p>The netCDF variable that describes this instance.</p></dd></p><p>
<dt><code>nc_dim</code></dt>
<dd><p>The netCDF dimension that describes the dimensionality.</p></dd></p><p>
<dt><code>values</code></dt>
<dd><p>Character vector of the label values.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-CFLabel-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>CFLabel$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

CF label object — CFLabel

<p><div class="r6-fields"></p><dl>
<dt><code>NCdim</code></dt>
<dd><p>The NCDimension that stores the netCDF dimension details.</p></dd>


<dt><code>values</code></dt>
<dd><p>The label values, a character vector.</p></dd>


</dl><p></div></p>

<p><div class="r6-active-bindings"></p><dl>
<dt><code>friendlyClassName</code></dt>
<dd><p>(read-only) A nice description of the class.</p></dd>


<dt><code>length</code></dt>
<dd><p>(read-only) The number of labels.</p></dd>


<dt><code>dimid</code></dt>
<dd><p>(read-only) The netCDF dimension id of this label.</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-CFLabel-new'><code>CFLabel$new()</code></a></p></li>
<li><p><a href='#method-CFLabel-clone'><code>CFLabel$clone()</code></a></p></li>
</ul>

</div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="append_attribute"><a href='../../ncdfCF/html/CFObject.html#method-CFObject-append_attribute'><code>ncdfCF::CFObject$append_attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="attribute"><a href='../../ncdfCF/html/CFObject.html#method-CFObject-attribute'><code>ncdfCF::CFObject$attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="delete_attribute"><a href='../../ncdfCF/html/CFObject.html#method-CFObject-delete_attribute'><code>ncdfCF::CFObject$delete_attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="print_attributes"><a href='../../ncdfCF/html/CFObject.html#method-CFObject-print_attributes'><code>ncdfCF::CFObject$print_attributes()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="set_attribute"><a href='../../ncdfCF/html/CFObject.html#method-CFObject-set_attribute'><code>ncdfCF::CFObject$set_attribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ncdfCF" data-topic="CFObject" data-id="write_attributes"><a href='../../ncdfCF/html/CFObject.html#method-CFObject-write_attributes'><code>ncdfCF::CFObject$write_attributes()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-CFLabel-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new instance of this class.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>CFLabel$new(grp, nc_var, nc_dim, values)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>grp</code></dt>
<dd><p>The group that contains the netCDF variable.</p></dd>


<dt><code>nc_var</code></dt>
<dd><p>The netCDF variable that describes this instance.</p></dd>


<dt><code>nc_dim</code></dt>
<dd><p>The netCDF dimension that describes the dimensionality.</p></dd>


<dt><code>values</code></dt>
<dd><p>Character vector of the label values.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-CFLabel-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>CFLabel$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


CFLabel: CF label object

Description

Arguments

Super class

Public fields

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Public fields

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Method clone()

Usage

Arguments

Method `new()`

Method `clone()`