SystemAdapter

<p>System Adapter Base Class</p>
<p>System Adapter Base Class</p>

internal

Provides accessible, interactive visualizations through the 'MAIDR'
(Multimodal Access and Interactive Data Representation) system. Converts
'ggplot2' and Base R plots into accessible HTML/SVG formats with keyboard
navigation, screen reader support, and 'sonification' capabilities. Supports
bar charts (simple, grouped, stacked), histograms, line plots, scatter plots,
box plots, heat maps, density/smooth curves, faceted plots, multi-panel
layouts (including patchwork), and multi-layered plot combinations. Enables
data exploration for users with visual impairments through multiple sensory
modalities. For more details see the 'MAIDR' project
<https://maidr.ai/>.

Niranjan Kalaiselvan

maidr

Multimodal Access and Interactive Data Representation

JooYoung Seo

SystemAdapter function

Format

<p><div class="r6-fields"></div></p><dl>
<dt><code>system_name</code></dt>
<dd><p>Name of the plotting system</p></dd><p></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/SystemAdapter%24new()?package=maidr&version=0.1.2" data-mini-rdoc="maidr::SystemAdapter$new()"><code>SystemAdapter$new()</code></a></p></li>
<li><p><a href="/link/SystemAdapter%24can_handle()?package=maidr&version=0.1.2" data-mini-rdoc="maidr::SystemAdapter$can_handle()"><code>SystemAdapter$can_handle()</code></a></p></li>
<li><p><a href="/link/SystemAdapter%24create_orchestrator()?package=maidr&version=0.1.2" data-mini-rdoc="maidr::SystemAdapter$create_orchestrator()"><code>SystemAdapter$create_orchestrator()</code></a></p></li>
<li><p><a href="/link/SystemAdapter%24clone()?package=maidr&version=0.1.2" data-mini-rdoc="maidr::SystemAdapter$clone()"><code>SystemAdapter$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-SystemAdapter-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Initialize the adapter</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SystemAdapter$new(system_name)</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>system_name</code></dt>
<dd><p>Name of the plotting system
Abstract method to check if this adapter can handle a plot object</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-SystemAdapter-can_handle"></a></p><div class="section" id="method-can-handle-">
<h3>Method <code>can_handle()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SystemAdapter$can_handle(plot_object)</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>plot_object</code></dt>
<dd><p>The plot object to check</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>TRUE if this adapter can handle the object, FALSE otherwise
Abstract method to create an orchestrator for this system</p>
</div><p></p><p></p><p><hr>
<a id="method-SystemAdapter-create_orchestrator"></a></p><div class="section" id="method-create-orchestrator-">
<h3>Method <code>create_orchestrator()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SystemAdapter$create_orchestrator(plot_object)</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>plot_object</code></dt>
<dd><p>The plot object to process</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>Orchestrator instance specific to this system</p>
</div><p></p><p></p><p><hr>
<a id="method-SystemAdapter-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>SystemAdapter$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

System Adapter Base Class — SystemAdapter

<p><div class="r6-fields"></p><dl>
<dt><code>system_name</code></dt>
<dd><p>Name of the plotting system</p></dd>


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


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

<ul>
<li><p><a href='#method-SystemAdapter-new'><code>SystemAdapter$new()</code></a></p></li>
<li><p><a href='#method-SystemAdapter-can_handle'><code>SystemAdapter$can_handle()</code></a></p></li>
<li><p><a href='#method-SystemAdapter-create_orchestrator'><code>SystemAdapter$create_orchestrator()</code></a></p></li>
<li><p><a href='#method-SystemAdapter-clone'><code>SystemAdapter$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-SystemAdapter-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initialize the adapter</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>SystemAdapter$new(system_name)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>system_name</code></dt>
<dd><p>Name of the plotting system
Abstract method to check if this adapter can handle a plot object</p></dd>


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

</div><p><hr>
<a id="method-SystemAdapter-can_handle"></a></p><div class='section' id='method-can-handle-'>
<h3>Method <code>can_handle()</code></h3>

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

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>plot_object</code></dt>
<dd><p>The plot object to check</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>TRUE if this adapter can handle the object, FALSE otherwise
Abstract method to create an orchestrator for this system</p>
</div>

</div><p><hr>
<a id="method-SystemAdapter-create_orchestrator"></a></p><div class='section' id='method-create-orchestrator-'>
<h3>Method <code>create_orchestrator()</code></h3>

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

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>plot_object</code></dt>
<dd><p>The plot object to process</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>Orchestrator instance specific to this system</p>
</div>

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


SystemAdapter: System Adapter Base Class

Description

Arguments

Format

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `can_handle()`

Usage

Arguments

Returns

Method `create_orchestrator()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Format

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method can_handle()

Usage

Arguments

Returns

Method create_orchestrator()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `can_handle()`

Method `create_orchestrator()`

Method `clone()`