zarr_codec_gzip

<p>The Zarr "gzip" codec compresses a raw vector prior to storing,
and uncompresses the raw vector when reading.</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_codec_gzip function

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

Super classes

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>level</code></dt>
<dd><p>The compression level of the gzip codec, an integer value
between 0L (no compression) and 9 (maximum compression).</p></dd><p></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_codec_gzip%24new()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_gzip$new()"><code>zarr_codec_gzip$new()</code></a></p></li>
<li><p><a href="/link/zarr_codec_gzip%24copy()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_gzip$copy()"><code>zarr_codec_gzip$copy()</code></a></p></li>
<li><p><a href="/link/zarr_codec_gzip%24encode()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_gzip$encode()"><code>zarr_codec_gzip$encode()</code></a></p></li>
<li><p><a href="/link/zarr_codec_gzip%24decode()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_gzip$decode()"><code>zarr_codec_gzip$decode()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="metadata_fragment"><a href="/link/zarr%3A%3Azarr_codec%24metadata_fragment()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr::zarr_codec$metadata_fragment()"><code>zarr::zarr_codec$metadata_fragment()</code></a></span></li>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="print"><a href="/link/zarr%3A%3Azarr_codec%24print()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr::zarr_codec$print()"><code>zarr::zarr_codec$print()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-zarr_codec_gzip-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new "gzip" codec object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_gzip$new(configuration = 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>configuration</code></dt>
<dd><p>Optional. A list with the configuration parameters
for this codec. The element <code>level</code> specifies the compression level of
this codec, ranging from 0 (no compression) to 9 (maximum compression).</p></dd></dl></div></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_codec_gzip-copy"></a></p><div class="section" id="method-copy-">
<h3>Method <code>copy()</code></h3>
<p>Create a new, independent copy of this codec.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_gzip$copy()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>An instance of <code>zarr_codec_gzip</code>.</p>
</div></p><p></p><p><hr>
<a id="method-zarr_codec_gzip-encode"></a></p><div class="section" id="method-encode-">
<h3>Method <code>encode()</code></h3>
<p>This method encodes a data object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_gzip$encode(data)</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</code></dt>
<dd><p>The data to be encoded.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>The encoded data object.</p>
</div><p></p><p></p><p><hr>
<a id="method-zarr_codec_gzip-decode"></a></p><div class="section" id="method-decode-">
<h3>Method <code>decode()</code></h3>
<p>This method decodes a data object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_gzip$decode(data)</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</code></dt>
<dd><p>The data to be decoded.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>The decoded data object.</p>
</div><p></p><p>
</p>

Methods

Zarr gzip codec — zarr_codec_gzip

<p><div class="r6-active-bindings"></p><dl>
<dt><code>level</code></dt>
<dd><p>The compression level of the gzip codec, an integer value
between 0L (no compression) and 9 (maximum compression).</p></dd>


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


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

<ul>
<li><p><a href='#method-zarr_codec_gzip-new'><code>zarr_codec_gzip$new()</code></a></p></li>
<li><p><a href='#method-zarr_codec_gzip-copy'><code>zarr_codec_gzip$copy()</code></a></p></li>
<li><p><a href='#method-zarr_codec_gzip-encode'><code>zarr_codec_gzip$encode()</code></a></p></li>
<li><p><a href='#method-zarr_codec_gzip-decode'><code>zarr_codec_gzip$decode()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="metadata_fragment"><a href='../../zarr/html/zarr_codec.html#method-zarr_codec-metadata_fragment'><code>zarr::zarr_codec$metadata_fragment()</code></a></span></li>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="print"><a href='../../zarr/html/zarr_codec.html#method-zarr_codec-print'><code>zarr::zarr_codec$print()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-zarr_codec_gzip-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new "gzip" codec object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_gzip$new(configuration = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>configuration</code></dt>
<dd><p>Optional. A list with the configuration parameters
for this codec. The element <code>level</code> specifies the compression level of
this codec, ranging from 0 (no compression) to 9 (maximum compression).</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_codec_gzip-copy"></a></p><div class='section' id='method-copy-'>
<h3>Method <code>copy()</code></h3>
<p>Create a new, independent copy of this codec.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_gzip$copy()</code></pre><p></div></p>
</div>

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

</div><p><hr>
<a id="method-zarr_codec_gzip-encode"></a></p><div class='section' id='method-encode-'>
<h3>Method <code>encode()</code></h3>
<p>This method encodes a data object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_gzip$encode(data)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>data</code></dt>
<dd><p>The data to be encoded.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>The encoded data object.</p>
</div>

</div><p><hr>
<a id="method-zarr_codec_gzip-decode"></a></p><div class='section' id='method-decode-'>
<h3>Method <code>decode()</code></h3>
<p>This method decodes a data object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_gzip$decode(data)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>data</code></dt>
<dd><p>The data to be decoded.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>The decoded data object.</p>
</div>

</div>


zarr_codec_gzip: Zarr gzip codec

Description

Arguments

Super classes

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `copy()`

Usage

Returns

Method `encode()`

Usage

Arguments

Returns

Method `decode()`

Usage

Arguments

Returns

Description

Arguments

Super classes

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method copy()

Usage

Returns

Method encode()

Usage

Arguments

Returns

Method decode()

Usage

Arguments

Returns

Method `new()`

Method `copy()`

Method `encode()`

Method `decode()`