Response

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

Response function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Response%24new()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$new()"><code>Response$new()</code></a></p></li>
<li><p><a href="/link/Response%24set_start_index()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$set_start_index()"><code>Response$set_start_index()</code></a></p></li>
<li><p><a href="/link/Response%24was_success()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$was_success()"><code>Response$was_success()</code></a></p></li>
<li><p><a href="/link/Response%24is_empty()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$is_empty()"><code>Response$is_empty()</code></a></p></li>
<li><p><a href="/link/Response%24has_json_content()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$has_json_content()"><code>Response$has_json_content()</code></a></p></li>
<li><p><a href="/link/Response%24to_list()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$to_list()"><code>Response$to_list()</code></a></p></li>
<li><p><a href="/link/Response%24to_records()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$to_records()"><code>Response$to_records()</code></a></p></li>
<li><p><a href="/link/Response%24clone()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::Response$clone()"><code>Response$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Response-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>Response$new(request, raw_response)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-set_start_index"></a></p><div class="section" id="method-set-start-index-">
<h3>Method <code>set_start_index()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Response$set_start_index(start)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-was_success"></a></p><div class="section" id="method-was-success-">
<h3>Method <code>was_success()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Response$was_success()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-is_empty"></a></p><div class="section" id="method-is-empty-">
<h3>Method <code>is_empty()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Response$is_empty()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-has_json_content"></a></p><div class="section" id="method-has-json-content-">
<h3>Method <code>has_json_content()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Response$has_json_content()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-to_list"></a></p><div class="section" id="method-to-list-">
<h3>Method <code>to_list()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Response$to_list()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-to_records"></a></p><div class="section" id="method-to-records-">
<h3>Method <code>to_records()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Response$to_records(start = 0)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Response-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>Response$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

Response — Response


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

<ul>
<li><p><a href='#method-Response-new'><code>Response$new()</code></a></p></li>
<li><p><a href='#method-Response-set_start_index'><code>Response$set_start_index()</code></a></p></li>
<li><p><a href='#method-Response-was_success'><code>Response$was_success()</code></a></p></li>
<li><p><a href='#method-Response-is_empty'><code>Response$is_empty()</code></a></p></li>
<li><p><a href='#method-Response-has_json_content'><code>Response$has_json_content()</code></a></p></li>
<li><p><a href='#method-Response-to_list'><code>Response$to_list()</code></a></p></li>
<li><p><a href='#method-Response-to_records'><code>Response$to_records()</code></a></p></li>
<li><p><a href='#method-Response-clone'><code>Response$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Response-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>Response$new(request, raw_response)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Response-set_start_index"></a></p><div class='section' id='method-set-start-index-'>
<h3>Method <code>set_start_index()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Response$set_start_index(start)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Response-was_success"></a></p><div class='section' id='method-was-success-'>
<h3>Method <code>was_success()</code></h3>

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


</div><p><hr>
<a id="method-Response-is_empty"></a></p><div class='section' id='method-is-empty-'>
<h3>Method <code>is_empty()</code></h3>

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


</div><p><hr>
<a id="method-Response-has_json_content"></a></p><div class='section' id='method-has-json-content-'>
<h3>Method <code>has_json_content()</code></h3>

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


</div><p><hr>
<a id="method-Response-to_list"></a></p><div class='section' id='method-to-list-'>
<h3>Method <code>to_list()</code></h3>

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


</div><p><hr>
<a id="method-Response-to_records"></a></p><div class='section' id='method-to-records-'>
<h3>Method <code>to_records()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Response$to_records(start = 0)</code></pre><p></div></p>
</div>


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


Response: Response

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Method `set_start_index()`

Usage

Method `was_success()`

Usage

Method `is_empty()`

Usage

Method `has_json_content()`

Usage

Method `to_list()`

Usage

Method `to_records()`

Usage

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public methods

Method new()

Usage

Method set_start_index()

Usage

Method was_success()

Usage

Method is_empty()

Usage

Method has_json_content()

Usage

Method to_list()

Usage

Method to_records()

Usage

Method clone()

Usage

Arguments

Method `new()`

Method `set_start_index()`

Method `was_success()`

Method `is_empty()`

Method `has_json_content()`

Method `to_list()`

Method `to_records()`

Method `clone()`