QueryCountWorker

<p><code>QueryCountWorker</code> objects are worker objects at each site of
a distributed QueryCount model computation</p>

Implementing algorithms and fitting models when sites (possibly remote) share
computation summaries rather than actual data over HTTP with a master R process (using
'opencpu', for example). A stratified Cox model and a singular value decomposition are
provided. The former makes direct use of code from the R 'survival' package. (That is,
the underlying Cox model code is derived from that in the R 'survival' package.)
Sites may provide data via several means: CSV files, Redcap API, etc. An extensible
design allows for new methods to be added in the future and includes facilities
for local prototyping and testing. Web applications are provided (via 'shiny') for
the implemented methods to help in designing and deploying the computations.

Balasubramanian Narasimhan

distcomp

Computations over Distributed Data without Aggregation

Marina Bendersky

Sam Gross

Thomas Lumley

QueryCountWorker function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/QueryCountWorker%24new()?package=distcomp&version=1.3-3" data-mini-rdoc="distcomp::QueryCountWorker$new()"><code>QueryCountWorker$new()</code></a></p></li>
<li><p><a href="/link/QueryCountWorker%24getStateful()?package=distcomp&version=1.3-3" data-mini-rdoc="distcomp::QueryCountWorker$getStateful()"><code>QueryCountWorker$getStateful()</code></a></p></li>
<li><p><a href="/link/QueryCountWorker%24kosher()?package=distcomp&version=1.3-3" data-mini-rdoc="distcomp::QueryCountWorker$kosher()"><code>QueryCountWorker$kosher()</code></a></p></li>
<li><p><a href="/link/QueryCountWorker%24queryCount()?package=distcomp&version=1.3-3" data-mini-rdoc="distcomp::QueryCountWorker$queryCount()"><code>QueryCountWorker$queryCount()</code></a></p></li>
<li><p><a href="/link/QueryCountWorker%24clone()?package=distcomp&version=1.3-3" data-mini-rdoc="distcomp::QueryCountWorker$clone()"><code>QueryCountWorker$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-QueryCountWorker-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new <code>QueryCountWorker</code> object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>QueryCountWorker$new(defn, data, stateful = 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>defn</code></dt>
<dd><p>the computation definition</p></dd></dl></div></p><p>
<dt><code>data</code></dt>
<dd><p>the local data</p></dd></p><p>
<dt><code>stateful</code></dt>
<dd><p>the statefulness flag, default <code>FALSE</code></p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>a new <code>QueryCountWorker</code> object</p>
</div><p></p><p></p><p><hr>
<a id="method-QueryCountWorker-getStateful"></a></p><div class="section" id="method-getstateful-">
<h3>Method <code>getStateful()</code></h3>
<p>Retrieve the value of the <code>stateful</code> field</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>QueryCountWorker$getStateful()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-QueryCountWorker-kosher"></a></p><div class="section" id="method-kosher-">
<h3>Method <code>kosher()</code></h3>
<p>Check if inputs and state of object are sane. For future use</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>QueryCountWorker$kosher()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p><code>TRUE</code> or <code>FALSE</code></p>
</div></p><p></p><p><hr>
<a id="method-QueryCountWorker-queryCount"></a></p><div class="section" id="method-querycount-">
<h3>Method <code>queryCount()</code></h3>
<p>Return the query count on the local data</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>QueryCountWorker$queryCount()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-QueryCountWorker-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>QueryCountWorker$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

R6 worker object for use as a worker with master objects generated by QueryCountMaster() — QueryCountWorker


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

<ul>
<li><p><a href='#method-QueryCountWorker-new'><code>QueryCountWorker$new()</code></a></p></li>
<li><p><a href='#method-QueryCountWorker-getStateful'><code>QueryCountWorker$getStateful()</code></a></p></li>
<li><p><a href='#method-QueryCountWorker-kosher'><code>QueryCountWorker$kosher()</code></a></p></li>
<li><p><a href='#method-QueryCountWorker-queryCount'><code>QueryCountWorker$queryCount()</code></a></p></li>
<li><p><a href='#method-QueryCountWorker-clone'><code>QueryCountWorker$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-QueryCountWorker-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new <code>QueryCountWorker</code> object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>QueryCountWorker$new(defn, data, stateful = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>defn</code></dt>
<dd><p>the computation definition</p></dd>


<dt><code>data</code></dt>
<dd><p>the local data</p></dd>


<dt><code>stateful</code></dt>
<dd><p>the statefulness flag, default <code>FALSE</code></p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>a new <code>QueryCountWorker</code> object</p>
</div>

</div><p><hr>
<a id="method-QueryCountWorker-getStateful"></a></p><div class='section' id='method-getstateful-'>
<h3>Method <code>getStateful()</code></h3>
<p>Retrieve the value of the <code>stateful</code> field</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>QueryCountWorker$getStateful()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-QueryCountWorker-kosher"></a></p><div class='section' id='method-kosher-'>
<h3>Method <code>kosher()</code></h3>
<p>Check if inputs and state of object are sane. For future use</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>QueryCountWorker$kosher()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p><code>TRUE</code> or <code>FALSE</code></p>
</div>

</div><p><hr>
<a id="method-QueryCountWorker-queryCount"></a></p><div class='section' id='method-querycount-'>
<h3>Method <code>queryCount()</code></h3>
<p>Return the query count on the local data</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>QueryCountWorker$queryCount()</code></pre><p></div></p>
</div>


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


QueryCountWorker: R6 worker object for use as a worker with master objects generated by `QueryCountMaster()`

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `getStateful()`

Usage

Method `kosher()`

Usage

Returns

Method `queryCount()`

Usage

Method `clone()`

Usage

Arguments

See Also

Description

Arguments

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method getStateful()

Usage

Method kosher()

Usage

Returns

Method queryCount()

Usage

Method clone()

Usage

Arguments

See Also

Method `new()`

Method `getStateful()`

Method `kosher()`

Method `queryCount()`

Method `clone()`