FromResponseRequestBuilder

<p>Builder for the case where a request is made with the context
of a previous response.</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

FromResponseRequestBuilder function

<p><code>ArctosR::RequestBuilder</code> -&gt; <code>FromResponseRequestBuilder</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/FromResponseRequestBuilder%24new()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::FromResponseRequestBuilder$new()"><code>FromResponseRequestBuilder$new()</code></a></p></li>
<li><p><a href="/link/FromResponseRequestBuilder%24request_more()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::FromResponseRequestBuilder$request_more()"><code>FromResponseRequestBuilder$request_more()</code></a></p></li>
<li><p><a href="/link/FromResponseRequestBuilder%24build_request()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::FromResponseRequestBuilder$build_request()"><code>FromResponseRequestBuilder$build_request()</code></a></p></li>
<li><p><a href="/link/FromResponseRequestBuilder%24clone()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::FromResponseRequestBuilder$clone()"><code>FromResponseRequestBuilder$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ArctosR" data-topic="RequestBuilder" data-id="debug"><a href="/link/ArctosR%3A%3ARequestBuilder%24debug()?package=ArctosR&version=0.1.3" data-mini-rdoc="ArctosR::ArctosR::RequestBuilder$debug()"><code>ArctosR::RequestBuilder$debug()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-FromResponseRequestBuilder-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>FromResponseRequestBuilder$new(response, records)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-FromResponseRequestBuilder-request_more"></a></p><div class="section" id="method-request-more-">
<h3>Method <code>request_more()</code></h3>
<p>Request at most <code>count</code> more records from this response's
original query</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>FromResponseRequestBuilder$request_more(count)</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>count</code></dt>
<dd><p>number of additional records to request</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>FromResponseRequestBuilder</p>
</div><p></p><p></p><p><hr>
<a id="method-FromResponseRequestBuilder-build_request"></a></p><div class="section" id="method-build-request-">
<h3>Method <code>build_request()</code></h3>
<p>Perform the request.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>FromResponseRequestBuilder$build_request()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Request</p>
</div></p><p></p><p><hr>
<a id="method-FromResponseRequestBuilder-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>FromResponseRequestBuilder$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

FromResponseRequestBuilder — FromResponseRequestBuilder


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

<ul>
<li><p><a href='#method-FromResponseRequestBuilder-new'><code>FromResponseRequestBuilder$new()</code></a></p></li>
<li><p><a href='#method-FromResponseRequestBuilder-request_more'><code>FromResponseRequestBuilder$request_more()</code></a></p></li>
<li><p><a href='#method-FromResponseRequestBuilder-build_request'><code>FromResponseRequestBuilder$build_request()</code></a></p></li>
<li><p><a href='#method-FromResponseRequestBuilder-clone'><code>FromResponseRequestBuilder$clone()</code></a></p></li>
</ul>

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

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


</div><p><hr>
<a id="method-FromResponseRequestBuilder-request_more"></a></p><div class='section' id='method-request-more-'>
<h3>Method <code>request_more()</code></h3>
<p>Request at most <code>count</code> more records from this response's
original query</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>FromResponseRequestBuilder$request_more(count)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>count</code></dt>
<dd><p>number of additional records to request</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>FromResponseRequestBuilder</p>
</div>

</div><p><hr>
<a id="method-FromResponseRequestBuilder-build_request"></a></p><div class='section' id='method-build-request-'>
<h3>Method <code>build_request()</code></h3>
<p>Perform the request.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>FromResponseRequestBuilder$build_request()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Request</p>
</div>

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


FromResponseRequestBuilder: FromResponseRequestBuilder

Description

Arguments

Super class

Methods

Public methods

Method `new()`

Usage

Method `request_more()`

Usage

Arguments

Returns

Method `build_request()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Methods

Public methods

Method new()

Usage

Method request_more()

Usage

Arguments

Returns

Method build_request()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `request_more()`

Method `build_request()`

Method `clone()`