zarr_data_type

<p>This class implements a Zarr data type as an extension point.
This class also manages the "fill_value" attribute associated with the data
type.</p>

The 'Zarr' specification is widely used to build libraries for the storage and retrieval of n-dimensional array data from data stores ranging from local file systems to the cloud. This package is a native 'Zarr' implementation in R with support for all required features of 'Zarr' version 3. It is designed to be extensible such that new stores, codecs and extensions can be added easily.

Patrick Van Laake

zarr

Native and Extensible R Driver for 'Zarr'

zarr_data_type function

<p><code>zarr::zarr_extension</code> -&gt; <code>zarr_data_type</code></p>

Super class

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>data_type</code></dt>
<dd><p>The data type for the Zarr array, a single character
string. Setting the data type will also set the fill value to its
default value.</p></dd><p></p><p>
<dt><code>Rtype</code></dt>
<dd><p>(read-only) The R data type corresponding to the Zarr data
type.</p></dd></p><p>
<dt><code>signed</code></dt>
<dd><p>(read-only) Flag that indicates if the Zarr data type is
signed or not.</p></dd></p><p>
<dt><code>size</code></dt>
<dd><p>(read-only) The size of the data type, in bytes.</p></dd></p><p>
<dt><code>fill_value</code></dt>
<dd><p>The fill value for the Zarr array, a single value that
agrees with the range of the <code>data_type</code>.</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/zarr_data_type%24new()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_data_type$new()"><code>zarr_data_type$new()</code></a></p></li>
<li><p><a href="/link/zarr_data_type%24print()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_data_type$print()"><code>zarr_data_type$print()</code></a></p></li>
<li><p><a href="/link/zarr_data_type%24metadata_fragment()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_data_type$metadata_fragment()"><code>zarr_data_type$metadata_fragment()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-zarr_data_type-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new data type object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_data_type$new(data_type, fill_value = NULL)</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>data_type</code></dt>
<dd><p>The name of the data type, a single character string.</p></dd></dl></div></p><p>
<dt><code>fill_value</code></dt>
<dd><p>Optionally, the fill value for the data type.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>An instance of this class.</p>
</div><p></p><p></p><p><hr>
<a id="method-zarr_data_type-print"></a></p><div class="section" id="method-print-">
<h3>Method <code><a href="/link/print()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::print()">print()</a></code></h3>
<p>Print a summary of the data type to the console.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_data_type$print()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-zarr_data_type-metadata_fragment"></a></p><div class="section" id="method-metadata-fragment-">
<h3>Method <code>metadata_fragment()</code></h3>
<p>Return the metadata fragment for this data type and its fill
value.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_data_type$metadata_fragment()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>A list with the metadata fragment.</p>
</div></p><p>
</p>

Methods

Zarr data types — zarr_data_type

<p><div class="r6-active-bindings"></p><dl>
<dt><code>data_type</code></dt>
<dd><p>The data type for the Zarr array, a single character
string. Setting the data type will also set the fill value to its
default value.</p></dd>


<dt><code>Rtype</code></dt>
<dd><p>(read-only) The R data type corresponding to the Zarr data
type.</p></dd>


<dt><code>signed</code></dt>
<dd><p>(read-only) Flag that indicates if the Zarr data type is
signed or not.</p></dd>


<dt><code>size</code></dt>
<dd><p>(read-only) The size of the data type, in bytes.</p></dd>


<dt><code>fill_value</code></dt>
<dd><p>The fill value for the Zarr array, a single value that
agrees with the range of the <code>data_type</code>.</p></dd>


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


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

<ul>
<li><p><a href='#method-zarr_data_type-new'><code>zarr_data_type$new()</code></a></p></li>
<li><p><a href='#method-zarr_data_type-print'><code>zarr_data_type$print()</code></a></p></li>
<li><p><a href='#method-zarr_data_type-metadata_fragment'><code>zarr_data_type$metadata_fragment()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-zarr_data_type-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new data type object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_data_type$new(data_type, fill_value = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>data_type</code></dt>
<dd><p>The name of the data type, a single character string.</p></dd>


<dt><code>fill_value</code></dt>
<dd><p>Optionally, the fill value for the data type.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>An instance of this class.</p>
</div>

</div><p><hr>
<a id="method-zarr_data_type-print"></a></p><div class='section' id='method-print-'>
<h3>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>
<p>Print a summary of the data type to the console.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_data_type$print()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-zarr_data_type-metadata_fragment"></a></p><div class='section' id='method-metadata-fragment-'>
<h3>Method <code>metadata_fragment()</code></h3>
<p>Return the metadata fragment for this data type and its fill
value.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_data_type$metadata_fragment()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>A list with the metadata fragment.</p>
</div>

</div>


zarr_data_type: Zarr data types

Description

Arguments

Super class

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `print()`

Usage

Method `metadata_fragment()`

Usage

Returns

Description

Arguments

Super class

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method print()

Usage

Method metadata_fragment()

Usage

Returns

Method `new()`

Method `print()`

Method `metadata_fragment()`