WorkerPool

<p>Worker Pool R6 Class</p>
<p>Worker Pool R6 Class</p>

Seamless integration between R and 'Goose' AI capabilities
including memory management, visualization enhancements, and workflow
automation. Save R objects to 'Goose' memory, apply Block branding to
visualizations, and manage data science project workflows.
For more information about 'Goose' AI, see <https://github.com/block/goose>.

Brandon Theriault

gooseR

R Integration for 'Goose' AI

WorkerPool function

<p><div class="r6-fields"></div></p><dl>
<dt><code>n_workers</code></dt>
<dd><p>Number of workers</p></dd><p></p><p>
<dt><code>queue</code></dt>
<dd><p>Query queue</p></dd></p><p>
<dt><code>results</code></dt>
<dd><p>Results list</p></dd></p><p>
<dt><code>active</code></dt>
<dd><p>Whether pool is active
Initialize worker pool</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/WorkerPool%24new()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$new()"><code>WorkerPool$new()</code></a></p></li>
<li><p><a href="/link/WorkerPool%24add()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$add()"><code>WorkerPool$add()</code></a></p></li>
<li><p><a href="/link/WorkerPool%24process()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$process()"><code>WorkerPool$process()</code></a></p></li>
<li><p><a href="/link/WorkerPool%24get_results()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$get_results()"><code>WorkerPool$get_results()</code></a></p></li>
<li><p><a href="/link/WorkerPool%24clear_queue()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$clear_queue()"><code>WorkerPool$clear_queue()</code></a></p></li>
<li><p><a href="/link/WorkerPool%24shutdown()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$shutdown()"><code>WorkerPool$shutdown()</code></a></p></li>
<li><p><a href="/link/WorkerPool%24clone()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::WorkerPool$clone()"><code>WorkerPool$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-WorkerPool-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>WorkerPool$new(n_workers = 4)</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>n_workers</code></dt>
<dd><p>Number of workers
Add query to queue</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-WorkerPool-add"></a></p><div class="section" id="method-add-">
<h3>Method <code>add()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>WorkerPool$add(query, id = NULL)</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>query</code></dt>
<dd><p>Query to add</p></dd></dl></div></p><p>
<dt><code>id</code></dt>
<dd><p>Optional query ID
Process all queued queries</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-WorkerPool-process"></a></p><div class="section" id="method-process-">
<h3>Method <code>process()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>WorkerPool$process(progress = TRUE)</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>progress</code></dt>
<dd><p>Show progress</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>List of results
Get results</p>
</div><p></p><p></p><p><hr>
<a id="method-WorkerPool-get_results"></a></p><div class="section" id="method-get-results-">
<h3>Method <code>get_results()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>WorkerPool$get_results()</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Results list
Clear queue</p>
</div></p><p></p><p><hr>
<a id="method-WorkerPool-clear_queue"></a></p><div class="section" id="method-clear-queue-">
<h3>Method <code>clear_queue()</code></h3>
<p>Remove all queued items without processing them.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>WorkerPool$clear_queue()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Invisible self
Shutdown pool</p>
</div></p><p></p><p><hr>
<a id="method-WorkerPool-shutdown"></a></p><div class="section" id="method-shutdown-">
<h3>Method <code>shutdown()</code></h3>
<p>Shut down the worker pool and reset the future plan to sequential.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>WorkerPool$shutdown()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Invisible self</p>
</div></p><p></p><p><hr>
<a id="method-WorkerPool-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>WorkerPool$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

Worker Pool R6 Class — WorkerPool

<p><div class="r6-fields"></p><dl>
<dt><code>n_workers</code></dt>
<dd><p>Number of workers</p></dd>


<dt><code>queue</code></dt>
<dd><p>Query queue</p></dd>


<dt><code>results</code></dt>
<dd><p>Results list</p></dd>


<dt><code>active</code></dt>
<dd><p>Whether pool is active
Initialize worker pool</p></dd>


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


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

<ul>
<li><p><a href='#method-WorkerPool-new'><code>WorkerPool$new()</code></a></p></li>
<li><p><a href='#method-WorkerPool-add'><code>WorkerPool$add()</code></a></p></li>
<li><p><a href='#method-WorkerPool-process'><code>WorkerPool$process()</code></a></p></li>
<li><p><a href='#method-WorkerPool-get_results'><code>WorkerPool$get_results()</code></a></p></li>
<li><p><a href='#method-WorkerPool-clear_queue'><code>WorkerPool$clear_queue()</code></a></p></li>
<li><p><a href='#method-WorkerPool-shutdown'><code>WorkerPool$shutdown()</code></a></p></li>
<li><p><a href='#method-WorkerPool-clone'><code>WorkerPool$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-WorkerPool-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>WorkerPool$new(n_workers = 4)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>n_workers</code></dt>
<dd><p>Number of workers
Add query to queue</p></dd>


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

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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>WorkerPool$add(query, id = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>query</code></dt>
<dd><p>Query to add</p></dd>


<dt><code>id</code></dt>
<dd><p>Optional query ID
Process all queued queries</p></dd>


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

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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>WorkerPool$process(progress = TRUE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>progress</code></dt>
<dd><p>Show progress</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>List of results
Get results</p>
</div>

</div><p><hr>
<a id="method-WorkerPool-get_results"></a></p><div class='section' id='method-get-results-'>
<h3>Method <code>get_results()</code></h3>

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

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Results list
Clear queue</p>
</div>

</div><p><hr>
<a id="method-WorkerPool-clear_queue"></a></p><div class='section' id='method-clear-queue-'>
<h3>Method <code>clear_queue()</code></h3>
<p>Remove all queued items without processing them.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>WorkerPool$clear_queue()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Invisible self
Shutdown pool</p>
</div>

</div><p><hr>
<a id="method-WorkerPool-shutdown"></a></p><div class='section' id='method-shutdown-'>
<h3>Method <code>shutdown()</code></h3>
<p>Shut down the worker pool and reset the future plan to sequential.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>WorkerPool$shutdown()</code></pre><p></div></p>
</div>

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

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


WorkerPool: Worker Pool R6 Class

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `add()`

Usage

Arguments

Method `process()`

Usage

Arguments

Returns

Method `get_results()`

Usage

Returns

Method `clear_queue()`

Usage

Returns

Method `shutdown()`

Usage

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method add()

Usage

Arguments

Method process()

Usage

Arguments

Returns

Method get_results()

Usage

Returns

Method clear_queue()

Usage

Returns

Method shutdown()

Usage

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `add()`

Method `process()`

Method `get_results()`

Method `clear_queue()`

Method `shutdown()`

Method `clone()`