Trait

.R_Trait_ctor

<p>Mean to mimic a in silico Trait. It is the working instances of
    the simulator.</p>

Accomplish high performance simulations in quantitative genetics.
The molecular genetic components are represented by R6/C++ classes and methods.
The core computational algorithm is implemented using bitsets according to
<doi:10.1534/g3.119.400373>. A mix between low and high level interfaces
provides great flexibility and allows user defined extensions and a wide range of
applications.

Fernando Toledo

isqg

In Silico Quantitative Genetics

Trait function

<p><div class="r6-fields"></div></p><dl>
<dt><code>.ptr</code></dt>
<dd><p>External pointer to the instance of the C++ class Specie.</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/.R_Trait_ctor%24new()?package=isqg&version=1.4" data-mini-rdoc="isqg::.R_Trait_ctor$new()"><code>.R_Trait_ctor$new()</code></a></p></li>
<li><p><a href="/link/.R_Trait_ctor%24print()?package=isqg&version=1.4" data-mini-rdoc="isqg::.R_Trait_ctor$print()"><code>.R_Trait_ctor$print()</code></a></p></li>
<li><p><a href="/link/.R_Trait_ctor%24alpha()?package=isqg&version=1.4" data-mini-rdoc="isqg::.R_Trait_ctor$alpha()"><code>.R_Trait_ctor$alpha()</code></a></p></li>
<li><p><a href="/link/.R_Trait_ctor%24clone()?package=isqg&version=1.4" data-mini-rdoc="isqg::.R_Trait_ctor$clone()"><code>.R_Trait_ctor$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create an instance of a Trait.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>.R_Trait_ctor$new(ptr)</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>ptr</code></dt>
<dd><p>an Smart pointer to an instance of a Trait C++ class.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A new `Trait` object.</p>
</div><p></p><p></p><p><hr>
<a id="method-print"></a></p><div class="section" id="method-print-">
<h3>Method <code><a href="/link/print()?package=isqg&version=1.4" data-mini-rdoc="isqg::print()">print()</a></code></h3>
<p>Print/Show an instance of the Trait class.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>.R_Trait_ctor$print(...)</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>...</code></dt>
<dd><p>further arguments to be passed to print.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-alpha"></a></p><div class="section" id="method-alpha-">
<h3>Method <code>alpha()</code></h3>
<p>Evaluates the breeding value.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>.R_Trait_ctor$alpha(gid)</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>gid</code></dt>
<dd><p>an instance of the class Specimen.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>the breeding value of the given specimen for the trait.</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>.R_Trait_ctor$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

Class providing object with methods to mimic in silico Traits — Trait

<p><div class="r6-fields"></p><dl>
<dt><code>.ptr</code></dt>
<dd><p>External pointer to the instance of the C++ class Specie.</p></dd>


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


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

<ul>
<li><p><a href='#method-new'><code>.R_Trait_ctor$new()</code></a></p></li>
<li><p><a href='#method-print'><code>.R_Trait_ctor$print()</code></a></p></li>
<li><p><a href='#method-alpha'><code>.R_Trait_ctor$alpha()</code></a></p></li>
<li><p><a href='#method-clone'><code>.R_Trait_ctor$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create an instance of a Trait.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>.R_Trait_ctor$new(ptr)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>ptr</code></dt>
<dd><p>an Smart pointer to an instance of a Trait C++ class.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A new `Trait` object.</p>
</div>

</div><p><hr>
<a id="method-print"></a></p><div class='section' id='method-print-'>
<h3>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>
<p>Print/Show an instance of the Trait class.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>.R_Trait_ctor$print(...)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>...</code></dt>
<dd><p>further arguments to be passed to print.</p></dd>


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

</div><p><hr>
<a id="method-alpha"></a></p><div class='section' id='method-alpha-'>
<h3>Method <code>alpha()</code></h3>
<p>Evaluates the breeding value.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>.R_Trait_ctor$alpha(gid)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>gid</code></dt>
<dd><p>an instance of the class Specimen.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>the breeding value of the given specimen for the trait.</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>.R_Trait_ctor$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>


Trait: Class providing object with methods to mimic in silico Traits

Description

Arguments

Value

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `print()`

Usage

Arguments

Method `alpha()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Value

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method print()

Usage

Arguments

Method alpha()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `print()`

Method `alpha()`

Method `clone()`