ApplicationInputInterface

internal

Perform Event Studies from through our <https://EventStudyTools.com> Application Programming Interface, parse the results, visualize it, and / or use the results in further analysis.

Dr. Mueller

EventStudy

Event Study Analysis

ApplicationInputInterface function

<p><code><a href="https://r6.r-lib.org/reference/R6Class.html">R6Class</a></code> object.</p>

Format

<p></p><p><dl>
  <dt><code>$new()</code></dt>
<dd><p>Constructor for ApplicationInputInterface. 
  This class should not used directly.</p></dd></dl></p><p>  <dt><code>$setNamedList()</code></dt>
<dd><p>Function to setup hierarchical <code>lists</code>.</p></dd></p><p>  <dt><code>$serialize()</code></dt>
<dd><p>Seriealize a <code>R6-Object</code>.</p></dd></p><p>  <dt><code>$serializeToJson(level)</code></dt>
<dd><p>Seriealize a <code>R6-Object</code> as a 
  <code>JSON-Object</code>.</p></dd></p><p>

</p>

Methods

<p></p><p><dl>
  <dt><code>type</code></dt>
<dd><p>Set the result file type.</p></dd></dl></p><p>  <dt><code>level</code></dt>
<dd><p>Level to seriealize.</p></dd></p><p>

</p>

Arguments


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/ApplicationInputInterface%24setResultFileType()?package=EventStudy&version=0.37" data-mini-rdoc="EventStudy::ApplicationInputInterface$setResultFileType()"><code>ApplicationInputInterface$setResultFileType()</code></a></p></li>
<li><p><a href="/link/ApplicationInputInterface%24setNamedList()?package=EventStudy&version=0.37" data-mini-rdoc="EventStudy::ApplicationInputInterface$setNamedList()"><code>ApplicationInputInterface$setNamedList()</code></a></p></li>
<li><p><a href="/link/ApplicationInputInterface%24serializeToJson()?package=EventStudy&version=0.37" data-mini-rdoc="EventStudy::ApplicationInputInterface$serializeToJson()"><code>ApplicationInputInterface$serializeToJson()</code></a></p></li>
<li><p><a href="/link/ApplicationInputInterface%24serialize()?package=EventStudy&version=0.37" data-mini-rdoc="EventStudy::ApplicationInputInterface$serialize()"><code>ApplicationInputInterface$serialize()</code></a></p></li>
<li><p><a href="/link/ApplicationInputInterface%24clone()?package=EventStudy&version=0.37" data-mini-rdoc="EventStudy::ApplicationInputInterface$clone()"><code>ApplicationInputInterface$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-setResultFileType"></a></p><div class="section" id="method-setresultfiletype-">
<h3>Method <code>setResultFileType()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ApplicationInputInterface$setResultFileType(type = "csv")</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-setNamedList"></a></p><div class="section" id="method-setnamedlist-">
<h3>Method <code>setNamedList()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ApplicationInputInterface$setNamedList(
  parentLevel,
  secondLevel = NULL,
  thirthLevel = NULL,
  parameterList
)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-serializeToJson"></a></p><div class="section" id="method-serializetojson-">
<h3>Method <code>serializeToJson()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ApplicationInputInterface$serializeToJson(level = NULL)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-serialize"></a></p><div class="section" id="method-serialize-">
<h3>Method <code><a href="/link/serialize()?package=EventStudy&version=0.37" data-mini-rdoc="EventStudy::serialize()">serialize()</a></code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ApplicationInputInterface$serialize()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-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>ApplicationInputInterface$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>

Abstract Application Input Interface for Event Study R Package — ApplicationInputInterface

<p><code><a href='https://r6.r-lib.org/reference/R6Class.html'>R6Class</a></code> object.</p>



<dl>
  <dt><code>$new()</code></dt>
<dd><p>Constructor for ApplicationInputInterface. 
  This class should not used directly.</p></dd>

  <dt><code>$setNamedList()</code></dt>
<dd><p>Function to setup hierarchical <code>lists</code>.</p></dd>

  <dt><code>$serialize()</code></dt>
<dd><p>Seriealize a <code>R6-Object</code>.</p></dd>

  <dt><code>$serializeToJson(level)</code></dt>
<dd><p>Seriealize a <code>R6-Object</code> as a 
  <code>JSON-Object</code>.</p></dd>


</dl>




<dl>
  <dt><code>type</code></dt>
<dd><p>Set the result file type.</p></dd>

  <dt><code>level</code></dt>
<dd><p>Level to seriealize.</p></dd>


</dl>



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

<ul>
<li><p><a href='#method-setResultFileType'><code>ApplicationInputInterface$setResultFileType()</code></a></p></li>
<li><p><a href='#method-setNamedList'><code>ApplicationInputInterface$setNamedList()</code></a></p></li>
<li><p><a href='#method-serializeToJson'><code>ApplicationInputInterface$serializeToJson()</code></a></p></li>
<li><p><a href='#method-serialize'><code>ApplicationInputInterface$serialize()</code></a></p></li>
<li><p><a href='#method-clone'><code>ApplicationInputInterface$clone()</code></a></p></li>
</ul>

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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ApplicationInputInterface$setResultFileType(type = "csv")</code></pre><p></div></p>
</div>


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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ApplicationInputInterface$setNamedList(
  parentLevel,
  secondLevel = NULL,
  thirthLevel = NULL,
  parameterList
)</code></pre><p></div></p>
</div>


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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ApplicationInputInterface$serializeToJson(level = NULL)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-serialize"></a></p><div class='section' id='method-serialize-'>
<h3>Method <code><a href='https://rdrr.io/r/base/serialize.html'>serialize()</a></code></h3>

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


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


ApplicationInputInterface: Abstract Application Input Interface for Event Study R Package

Description

Format

Methods

Arguments

Methods

Public methods

Method `setResultFileType()`

Usage

Method `setNamedList()`

Usage

Method `serializeToJson()`

Usage

Method `serialize()`

Usage

Method `clone()`

Usage

Arguments

Description

Format

Methods

Arguments

Methods

Public methods

Method setResultFileType()

Usage

Method setNamedList()

Usage

Method serializeToJson()

Usage

Method serialize()

Usage

Method clone()

Usage

Arguments

Method `setResultFileType()`

Method `setNamedList()`

Method `serializeToJson()`

Method `serialize()`

Method `clone()`