Record

Interact with 'LaminDB'. 'LaminDB' is an open-source data
framework for biology. This package allows you to query and download
data from 'LaminDB' instances.

Robrecht Cannoodt

laminr

Client for 'LaminDB'

Luke Zappia

Data Intuitive 

Lamin Labs 

Record function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Record%24new()?package=laminr&version=0.4.1" data-mini-rdoc="laminr::Record$new()"><code>Record$new()</code></a></p></li>
<li><p><a href="/link/Record%24delete()?package=laminr&version=0.4.1" data-mini-rdoc="laminr::Record$delete()"><code>Record$delete()</code></a></p></li>
<li><p><a href="/link/Record%24print()?package=laminr&version=0.4.1" data-mini-rdoc="laminr::Record$print()"><code>Record$print()</code></a></p></li>
<li><p><a href="/link/Record%24to_string()?package=laminr&version=0.4.1" data-mini-rdoc="laminr::Record$to_string()"><code>Record$to_string()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Record-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates an instance of this R6 class. This class should not be instantiated directly,
but rather by connecting to a LaminDB instance using the <code>connect()</code> function.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Record$new(instance, registry, api, 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>instance</code></dt>
<dd><p>The instance the record belongs to.</p></dd></dl></div></p><p>
<dt><code>registry</code></dt>
<dd><p>The registry the record belongs to.</p></dd></p><p>
<dt><code>api</code></dt>
<dd><p>The API for the instance.</p></dd></p><p>
<dt><code>data</code></dt>
<dd><p>The data for the record.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Record-delete"></a></p><div class="section" id="method-delete-">
<h3>Method <code>delete()</code></h3>
<p>Delete a <code>Record</code></p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Record$delete(verbose = 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>verbose</code></dt>
<dd><p>Whether to print details of the API call</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p><code>TRUE</code> invisibly if the deletion is successful</p>
</div><p></p><p></p><p><hr>
<a id="method-Record-print"></a></p><div class="section" id="method-print-">
<h3>Method <code><a href="/link/print()?package=laminr&version=0.4.1" data-mini-rdoc="laminr::print()">print()</a></code></h3>
<p>Print a <code>Record</code></p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Record$print(style = TRUE)</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>style</code></dt>
<dd><p>Logical, whether the output is styled using ANSI codes</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Record-to_string"></a></p><div class="section" id="method-to-string-">
<h3>Method <code>to_string()</code></h3>
<p>Create a string representation of a <code>Record</code></p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Record$to_string(style = 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>style</code></dt>
<dd><p>Logical, whether the output is styled using ANSI codes</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A <code>cli::cli_ansi_string</code> if <code>style = TRUE</code> or a character vector</p>
</div><p></p><p>
</p>

Methods

Record — Record


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

<ul>
<li><p><a href='#method-Record-new'><code>Record$new()</code></a></p></li>
<li><p><a href='#method-Record-delete'><code>Record$delete()</code></a></p></li>
<li><p><a href='#method-Record-print'><code>Record$print()</code></a></p></li>
<li><p><a href='#method-Record-to_string'><code>Record$to_string()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Record-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates an instance of this R6 class. This class should not be instantiated directly,
but rather by connecting to a LaminDB instance using the <code>connect()</code> function.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Record$new(instance, registry, api, data)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>instance</code></dt>
<dd><p>The instance the record belongs to.</p></dd>


<dt><code>registry</code></dt>
<dd><p>The registry the record belongs to.</p></dd>


<dt><code>api</code></dt>
<dd><p>The API for the instance.</p></dd>


<dt><code>data</code></dt>
<dd><p>The data for the record.</p></dd>


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

</div><p><hr>
<a id="method-Record-delete"></a></p><div class='section' id='method-delete-'>
<h3>Method <code>delete()</code></h3>
<p>Delete a <code>Record</code></p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Record$delete(verbose = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>verbose</code></dt>
<dd><p>Whether to print details of the API call</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p><code>TRUE</code> invisibly if the deletion is successful</p>
</div>

</div><p><hr>
<a id="method-Record-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 <code>Record</code></p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Record$print(style = TRUE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>style</code></dt>
<dd><p>Logical, whether the output is styled using ANSI codes</p></dd>


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

</div><p><hr>
<a id="method-Record-to_string"></a></p><div class='section' id='method-to-string-'>
<h3>Method <code>to_string()</code></h3>
<p>Create a string representation of a <code>Record</code></p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Record$to_string(style = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>style</code></dt>
<dd><p>Logical, whether the output is styled using ANSI codes</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A <code>cli::cli_ansi_string</code> if <code>style = TRUE</code> or a character vector</p>
</div>

</div>


Record: Record

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Arguments

Method `delete()`

Usage

Arguments

Returns

Method `print()`

Usage

Arguments

Method `to_string()`

Usage

Arguments

Returns

Description

Arguments

Methods

Public methods

Method new()

Usage

Arguments

Method delete()

Usage

Arguments

Returns

Method print()

Usage

Arguments

Method to_string()

Usage

Arguments

Returns

Method `new()`

Method `delete()`

Method `print()`

Method `to_string()`