ShinyProducer

<p>A Producer with methods specific for Shiny</p>
<p>A Producer with methods specific for Shiny</p>

Provides tools for passing messages between R processes.
Shiny examples are provided showing how to perform useful tasks such as:
updating reactive values from within a future, progress bars for long running
async tasks, and interrupting async tasks based on user input.

Ian Fellows

Tools for Message Passing Between Processes

ShinyProducer function

<p><code>ipc::Producer</code> -&gt; <code>ShinyProducer</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/ShinyProducer%24fireInterrupt()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ShinyProducer$fireInterrupt()"><code>ShinyProducer$fireInterrupt()</code></a></p></li>
<li><p><a href="/link/ShinyProducer%24fireNotify()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ShinyProducer$fireNotify()"><code>ShinyProducer$fireNotify()</code></a></p></li>
<li><p><a href="/link/ShinyProducer%24fireAssignReactive()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ShinyProducer$fireAssignReactive()"><code>ShinyProducer$fireAssignReactive()</code></a></p></li>
<li><p><a href="/link/ShinyProducer%24clone()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ShinyProducer$clone()"><code>ShinyProducer$clone()</code></a></p></li>
</ul></p><p></p></div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fire"><a href="/link/ipc%3A%3AProducer%24fire()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$fire()"><code>ipc::Producer$fire()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fireCall"><a href="/link/ipc%3A%3AProducer%24fireCall()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$fireCall()"><code>ipc::Producer$fireCall()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fireDoCall"><a href="/link/ipc%3A%3AProducer%24fireDoCall()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$fireDoCall()"><code>ipc::Producer$fireDoCall()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fireEval"><a href="/link/ipc%3A%3AProducer%24fireEval()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$fireEval()"><code>ipc::Producer$fireEval()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="getSource"><a href="/link/ipc%3A%3AProducer%24getSource()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$getSource()"><code>ipc::Producer$getSource()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="initialize"><a href="/link/ipc%3A%3AProducer%24initialize()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$initialize()"><code>ipc::Producer$initialize()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="setSource"><a href="/link/ipc%3A%3AProducer%24setSource()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::ipc::Producer$setSource()"><code>ipc::Producer$setSource()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-ShinyProducer-fireInterrupt"></a></p><div class="section" id="method-fireinterrupt-">
<h3>Method <code>fireInterrupt()</code></h3>
<p>Sends an error with message <code>msg</code>.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ShinyProducer$fireInterrupt(msg = "Interrupt")</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>msg</code></dt>
<dd><p>A string</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-ShinyProducer-fireNotify"></a></p><div class="section" id="method-firenotify-">
<h3>Method <code>fireNotify()</code></h3>
<p>Sends a signal to create a shiny Notification with message <code>msg</code>.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ShinyProducer$fireNotify(msg = "Notification")</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>msg</code></dt>
<dd><p>A string</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-ShinyProducer-fireAssignReactive"></a></p><div class="section" id="method-fireassignreactive-">
<h3>Method <code>fireAssignReactive()</code></h3>
<p>Signals for assignment for reactive <code>name</code>  to <code>value</code>.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ShinyProducer$fireAssignReactive(name, value)</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>name</code></dt>
<dd><p>The name of the reactive value.</p></dd></dl></div></p><p>
<dt><code>value</code></dt>
<dd><p>The value to assign the reactive to.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-ShinyProducer-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>ShinyProducer$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

A Producer with methods specific for Shiny — ShinyProducer


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

<ul>
<li><p><a href='#method-ShinyProducer-fireInterrupt'><code>ShinyProducer$fireInterrupt()</code></a></p></li>
<li><p><a href='#method-ShinyProducer-fireNotify'><code>ShinyProducer$fireNotify()</code></a></p></li>
<li><p><a href='#method-ShinyProducer-fireAssignReactive'><code>ShinyProducer$fireAssignReactive()</code></a></p></li>
<li><p><a href='#method-ShinyProducer-clone'><code>ShinyProducer$clone()</code></a></p></li>
</ul>

</div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fire"><a href='../../ipc/html/Producer.html#method-Producer-fire'><code>ipc::Producer$fire()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fireCall"><a href='../../ipc/html/Producer.html#method-Producer-fireCall'><code>ipc::Producer$fireCall()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fireDoCall"><a href='../../ipc/html/Producer.html#method-Producer-fireDoCall'><code>ipc::Producer$fireDoCall()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="fireEval"><a href='../../ipc/html/Producer.html#method-Producer-fireEval'><code>ipc::Producer$fireEval()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="getSource"><a href='../../ipc/html/Producer.html#method-Producer-getSource'><code>ipc::Producer$getSource()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="initialize"><a href='../../ipc/html/Producer.html#method-Producer-initialize'><code>ipc::Producer$initialize()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ipc" data-topic="Producer" data-id="setSource"><a href='../../ipc/html/Producer.html#method-Producer-setSource'><code>ipc::Producer$setSource()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-ShinyProducer-fireInterrupt"></a></p><div class='section' id='method-fireinterrupt-'>
<h3>Method <code>fireInterrupt()</code></h3>
<p>Sends an error with message <code>msg</code>.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ShinyProducer$fireInterrupt(msg = "Interrupt")</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>msg</code></dt>
<dd><p>A string</p></dd>


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

</div><p><hr>
<a id="method-ShinyProducer-fireNotify"></a></p><div class='section' id='method-firenotify-'>
<h3>Method <code>fireNotify()</code></h3>
<p>Sends a signal to create a shiny Notification with message <code>msg</code>.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ShinyProducer$fireNotify(msg = "Notification")</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>msg</code></dt>
<dd><p>A string</p></dd>


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

</div><p><hr>
<a id="method-ShinyProducer-fireAssignReactive"></a></p><div class='section' id='method-fireassignreactive-'>
<h3>Method <code>fireAssignReactive()</code></h3>
<p>Signals for assignment for reactive <code>name</code>  to <code>value</code>.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ShinyProducer$fireAssignReactive(name, value)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>name</code></dt>
<dd><p>The name of the reactive value.</p></dd>


<dt><code>value</code></dt>
<dd><p>The value to assign the reactive to.</p></dd>


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

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


ShinyProducer: A Producer with methods specific for Shiny

Description

Arguments

Super class

Methods

Public methods

Method `fireInterrupt()`

Usage

Arguments

Method `fireNotify()`

Usage

Arguments

Method `fireAssignReactive()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Super class

Methods

Public methods

Method fireInterrupt()

Usage

Arguments

Method fireNotify()

Usage

Arguments

Method fireAssignReactive()

Usage

Arguments

Method clone()

Usage

Arguments

Details

Method `fireInterrupt()`

Method `fireNotify()`

Method `fireAssignReactive()`

Method `clone()`