Records

<p>A (possibly nested) data frame of records returned by a static
set of query and result parameters</p>

Performs requests to the 'Arctos' API to download data. Provides a
set of builder classes for performing complex requests, as well as a set of
simple functions for automating many common requests and workflows. More
information about 'Arctos' can be found in
Cicero et al. (2024) <doi:10.1371/journal.pone.0296478> or on their website
<https://arctosdb.org/>.

Harlan Williams

ArctosR

An Interface to the 'Arctos' Database

Harlan R. Williams

Marlon E. Cobos

Jocelyn P. Colella

Michelle S. Koo

Vijay Barve

Records function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Records%24new()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Records$new()"><code>Records$new()</code></a></p></li>
<li><p><a href="/link/Records%24append()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Records$append()"><code>Records$append()</code></a></p></li>
<li><p><a href="/link/Records%24save_flat_csv()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Records$save_flat_csv()"><code>Records$save_flat_csv()</code></a></p></li>
<li><p><a href="/link/Records%24save_nested_csvs()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Records$save_nested_csvs()"><code>Records$save_nested_csvs()</code></a></p></li>
<li><p><a href="/link/Records%24expand_col()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Records$expand_col()"><code>Records$expand_col()</code></a></p></li>
<li><p><a href="/link/Records%24clone()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Records$clone()"><code>Records$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Records-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Records$new(df, tbl)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Records-append"></a></p><div class="section" id="method-append-">
<h3>Method <code><a href="/link/append()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::append()">append()</a></code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Records$append(other)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Records-save_flat_csv"></a></p><div class="section" id="method-save-flat-csv-">
<h3>Method <code>save_flat_csv()</code></h3>
<p>Writes the data in the response object to a CSV file.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Records$save_flat_csv(file_path)</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Records-save_nested_csvs"></a></p><div class="section" id="method-save-nested-csvs-">
<h3>Method <code>save_nested_csvs()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Records$save_nested_csvs(file_path)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Records-expand_col"></a></p><div class="section" id="method-expand-col-">
<h3>Method <code>expand_col()</code></h3>
<p>Expand a column of nested JSON tables in the response to a
list of dataframes.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Records$expand_col(column)</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>col</code></dt>
<dd><p>(<code>string</code>)</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Records-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>Records$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

Records — Records


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

<ul>
<li><p><a href='#method-Records-new'><code>Records$new()</code></a></p></li>
<li><p><a href='#method-Records-append'><code>Records$append()</code></a></p></li>
<li><p><a href='#method-Records-save_flat_csv'><code>Records$save_flat_csv()</code></a></p></li>
<li><p><a href='#method-Records-save_nested_csvs'><code>Records$save_nested_csvs()</code></a></p></li>
<li><p><a href='#method-Records-expand_col'><code>Records$expand_col()</code></a></p></li>
<li><p><a href='#method-Records-clone'><code>Records$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Records-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Records$new(df, tbl)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Records-append"></a></p><div class='section' id='method-append-'>
<h3>Method <code><a href='https://rdrr.io/r/base/append.html'>append()</a></code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Records$append(other)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Records-save_flat_csv"></a></p><div class='section' id='method-save-flat-csv-'>
<h3>Method <code>save_flat_csv()</code></h3>
<p>Writes the data in the response object to a CSV file.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Records$save_flat_csv(file_path)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Records-save_nested_csvs"></a></p><div class='section' id='method-save-nested-csvs-'>
<h3>Method <code>save_nested_csvs()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Records$save_nested_csvs(file_path)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Records-expand_col"></a></p><div class='section' id='method-expand-col-'>
<h3>Method <code>expand_col()</code></h3>
<p>Expand a column of nested JSON tables in the response to a
list of dataframes.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Records$expand_col(column)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>col</code></dt>
<dd><p>(<code>string</code>)</p></dd>


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

</div><p><hr>
<a id="method-Records-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>Records$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>


Records: Records

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Method `append()`

Usage

Method `save_flat_csv()`

Usage

Method `save_nested_csvs()`

Usage

Method `expand_col()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public methods

Method new()

Usage

Method append()

Usage

Method save_flat_csv()

Usage

Method save_nested_csvs()

Usage

Method expand_col()

Usage

Arguments

Method clone()

Usage

Arguments

Method `new()`

Method `append()`

Method `save_flat_csv()`

Method `save_nested_csvs()`

Method `expand_col()`

Method `clone()`