MockDataGenerator

<p>Object that stores mock data configurations and generated datasets</p>

Generate mock data in R using YAML configuration.

Jakub Nowicki

fixtuRes

Mock Data Generator

MockDataGenerator function

<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/MockDataGenerator%24new()?package=fixtuRes&version=0.1.3" data-mini-rdoc="fixtuRes::MockDataGenerator$new()"><code>MockDataGenerator$new()</code></a></p></li>
<li><p><a href="/link/MockDataGenerator%24get_data()?package=fixtuRes&version=0.1.3" data-mini-rdoc="fixtuRes::MockDataGenerator$get_data()"><code>MockDataGenerator$get_data()</code></a></p></li>
<li><p><a href="/link/MockDataGenerator%24get_all_data()?package=fixtuRes&version=0.1.3" data-mini-rdoc="fixtuRes::MockDataGenerator$get_all_data()"><code>MockDataGenerator$get_all_data()</code></a></p></li>
<li><p><a href="/link/MockDataGenerator%24clone()?package=fixtuRes&version=0.1.3" data-mini-rdoc="fixtuRes::MockDataGenerator$clone()"><code>MockDataGenerator$clone()</code></a></p></li>
</ul>
</p><p></p><h3>Method <code>new()</code></h3><p></p><p>Create a new MockDataGenerator object
</p><h3>Usage</h3><p></p><p><pre>MockDataGenerator$new(configuration)</pre></p><p></p><h3>Arguments</h3><p></p><p><dl class="dl-horizontal">
<dt><code>configuration</code></dt><dd><p>list or path to YAML file with datasets configurations.
Check
<a href="https://github.com/jakubnowicki/fixtuRes/blob/master/vignettes/configuration.Rmd">configuration</a>
for details.
For a sample YAML check
<a href="https://github.com/jakubnowicki/fixtuRes/tree/master/examples">examples</a>.</p></dd>
</dl></p><p></p><h3>Returns</h3><p></p><p>A new MockDataGenerator object</p><p></p><p></p><h3>Method <code>get_data()</code></h3><p></p><p>Get a dataset (if does not exist, generate it)
</p><h3>Usage</h3><p></p><p><pre>MockDataGenerator$get_data(data_name, size = NULL, refresh = FALSE)</pre></p><p></p><h3>Arguments</h3><p></p><p><dl class="dl-horizontal">
<dt><code>data_name</code></dt><dd><p>string, data set name to retrieve</p></dd></dl></p><p><dt><code>size</code></dt><dd><p>integer, size of dataset (if provided, will refresh dataset)</p></dd></p><p><dt><code>refresh</code></dt><dd><p>boolean, refresh existing data?</p></dd>
</p><p></p><h3>Returns</h3><p></p><p>mock dataset</p><p></p><p></p><h3>Method <code>get_all_data()</code></h3><p></p><p>Get all datasets
</p><h3>Usage</h3><p></p><p><pre>MockDataGenerator$get_all_data(refresh = FALSE, sizes = NULL)</pre></p><p></p><h3>Arguments</h3><p></p><p><dl class="dl-horizontal">
<dt><code>refresh</code></dt><dd><p>boolean, refresh existing data?</p></dd></dl></p><p><dt><code>sizes</code></dt><dd><p>integer, or vector of integers with data sizes</p></dd>
</p><p></p><h3>Returns</h3><p></p><p>list with all datasets</p><p></p><p></p><h3>Method <code>clone()</code></h3><p></p><p>The objects of this class are cloneable with this method.
</p><h3>Usage</h3><p></p><p><pre>MockDataGenerator$clone(deep = FALSE)</pre></p><p></p><h3>Arguments</h3><p></p><p><dl class="dl-horizontal">
<dt><code>deep</code></dt><dd><p>Whether to make a deep clone.</p></dd>
</dl></p>

MockDataGenerator: MockDataGenerator

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `get_data()`

Usage

Arguments

Returns

Method `get_all_data()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method get_data()

Usage

Arguments

Returns

Method get_all_data()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `get_data()`

Method `get_all_data()`

Method `clone()`