registry-class

registry

A <code>registry</code> stores metadata and flag configuration of a bitfield.

Record algorithmic and analytic meta data along a workflow to store
that in a bitfield, which can be published alongside any (modelled) data
products.

Steffen Ehrmann

bitfield

Handle Bitfields to Record Meta Data

registry-class function

<dl>
<dt><code>name</code></dt>
<dd><code><a href="/link/character(1)?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::character(1)">character(1)</a></code> short name of the bitfield.</dd></dl>
<dt><code>version</code></dt>
<dd><code><a href="/link/character(1)?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::character(1)">character(1)</a></code> automatically created version
tag of the bitfield. This consists of the package version, the version of R
and the date of creation of the bitfield.</dd>
<dt><code>md5</code></dt>
<dd><code><a href="/link/character(1)?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::character(1)">character(1)</a></code> the MD5 checksum of the bitfield as
determined with <a href="/link/md5sum?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::md5sum">md5sum</a>.</dd>
<dt><code>description</code></dt>
<dd><code><a href="/link/character(1)?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::character(1)">character(1)</a></code> longer description of the
bitfield.</dd>
<dt><code>template</code></dt>
<dd><code><a href="/link/list(.)?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::list(.)">list(.)</a></code> structural metadata for encoding/decoding,
including: <code>type</code> ("data.frame" or "SpatRaster"), <code>width</code> (total
bits), <code>length</code> (number of observations/cells), and for rasters:
<code>nrows</code>, <code>ncols</code>, <code>extent</code>, <code>crs</code>.</dd>
<dt><code>flags</code></dt>
<dd><code><a href="/link/list(.)?package=bitfield&version=1.0.0" data-mini-rdoc="bitfield::list(.)">list(.)</a></code> list of flags in the registry.</dd>

Slots

Bit registry class (S4) and methods — registry-class

<dl>
<dt><code>name</code></dt>
<dd><code><a href='https://rdrr.io/r/base/character.html'>character(1)</a></code> short name of the bitfield.</dd>


<dt><code>version</code></dt>
<dd><code><a href='https://rdrr.io/r/base/character.html'>character(1)</a></code> automatically created version
tag of the bitfield. This consists of the package version, the version of R
and the date of creation of the bitfield.</dd>


<dt><code>md5</code></dt>
<dd><code><a href='https://rdrr.io/r/base/character.html'>character(1)</a></code> the MD5 checksum of the bitfield as
determined with <a href='https://rdrr.io/r/tools/md5sum.html'>md5sum</a>.</dd>


<dt><code>description</code></dt>
<dd><code><a href='https://rdrr.io/r/base/character.html'>character(1)</a></code> longer description of the
bitfield.</dd>


<dt><code>template</code></dt>
<dd><code><a href='https://rdrr.io/r/base/list.html'>list(.)</a></code> structural metadata for encoding/decoding,
including: <code>type</code> ("data.frame" or "SpatRaster"), <code>width</code> (total
bits), <code>length</code> (number of observations/cells), and for rasters:
<code>nrows</code>, <code>ncols</code>, <code>extent</code>, <code>crs</code>.</dd>


<dt><code>flags</code></dt>
<dd><code><a href='https://rdrr.io/r/base/list.html'>list(.)</a></code> list of flags in the registry.</dd>


</dl>

registry-class: Bit registry class (S4) and methods

Description

Arguments

Slots