diff options
Diffstat (limited to 'docs/reference/mkindsg.html')
| -rw-r--r-- | docs/reference/mkindsg.html | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/docs/reference/mkindsg.html b/docs/reference/mkindsg.html index ceee4f37..37ec29bd 100644 --- a/docs/reference/mkindsg.html +++ b/docs/reference/mkindsg.html @@ -93,20 +93,27 @@ dataset if no data are supplied.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="co"># S3 method for mkindsg</span> -<span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span>, data <span class="op">=</span> <span class="cn">FALSE</span>, verbose <span class="op">=</span> <span class="va">data</span>, <span class="va">...</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for mkindsg</span></span> +<span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span>, data <span class="op">=</span> <span class="cn">FALSE</span>, verbose <span class="op">=</span> <span class="va">data</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>x</dt> <dd><p>An mkindsg object.</p></dd> + + <dt>data</dt> <dd><p>Should the mkinds objects be printed with their data?</p></dd> + + <dt>verbose</dt> <dd><p>Should the mkinds objects be printed?</p></dd> + + <dt>...</dt> <dd><p>Not used.</p></dd> + </dl></div> <div id="public-fields"> <h2>Public fields</h2> @@ -148,7 +155,7 @@ or covariates like soil pH).</p></dd> <h3 id="method-new-">Method <code>new()</code><a class="anchor" aria-label="anchor" href="#method-new-"></a></h3> <p>Create a new mkindsg object</p><div class="section"> <h4 id="usage">Usage<a class="anchor" aria-label="anchor" href="#usage"></a></h4> -<p></p><div class="r"><div class="sourceCode"><pre><code><span class="va"><a href="../reference/mkindsg.html">mkindsg</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span>title <span class="op">=</span> <span class="st">""</span>, <span class="va">ds</span>, f_time_norm <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fu"><a href="https://rdrr.io/r/base/length.html" class="external-link">length</a></span><span class="op">(</span><span class="va">ds</span><span class="op">)</span><span class="op">)</span>, <span class="va">meta</span><span class="op">)</span></code></pre></div><p></p></div> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va"><a href="../reference/mkindsg.html">mkindsg</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span>title <span class="op">=</span> <span class="st">""</span>, <span class="va">ds</span>, f_time_norm <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fu"><a href="https://rdrr.io/r/base/length.html" class="external-link">length</a></span><span class="op">(</span><span class="va">ds</span><span class="op">)</span><span class="op">)</span>, <span class="va">meta</span><span class="op">)</span></span></code></pre></div><p></p></div> </div> <div class="section"> @@ -176,7 +183,7 @@ or covariates like soil pH).</p></dd> <h3 id="method-clone-">Method <code>clone()</code><a class="anchor" aria-label="anchor" href="#method-clone-"></a></h3> <p>The objects of this class are cloneable with this method.</p><div class="section"> <h4 id="usage-1">Usage<a class="anchor" aria-label="anchor" href="#usage-1"></a></h4> -<p></p><div class="r"><div class="sourceCode"><pre><code><span class="va">mkindsg</span><span class="op">$</span><span class="fu">clone</span><span class="op">(</span>deep <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></code></pre></div><p></p></div> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">mkindsg</span><span class="op">$</span><span class="fu">clone</span><span class="op">(</span>deep <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div> </div> <div class="section"> @@ -194,15 +201,15 @@ or covariates like soil pH).</p></dd> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="va">mdsg</span> <span class="op"><-</span> <span class="va">mkindsg</span><span class="op">$</span><span class="fu">new</span><span class="op">(</span><span class="st">"Experimental X"</span>, <span class="va">experimental_data_for_UBA_2019</span><span class="op">[</span><span class="fl">6</span><span class="op">:</span><span class="fl">10</span><span class="op">]</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">mdsg</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="va">mdsg</span> <span class="op"><-</span> <span class="va">mkindsg</span><span class="op">$</span><span class="fu">new</span><span class="op">(</span><span class="st">"Experimental X"</span>, <span class="va">experimental_data_for_UBA_2019</span><span class="op">[</span><span class="fl">6</span><span class="op">:</span><span class="fl">10</span><span class="op">]</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">mdsg</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> <mkindsg> holding 5 mkinds objects</span> <span class="r-out co"><span class="r-pr">#></span> Title $title: Experimental X </span> <span class="r-out co"><span class="r-pr">#></span> Occurrence of observed compounds $observed_n:</span> <span class="r-out co"><span class="r-pr">#></span> parent A1 </span> <span class="r-out co"><span class="r-pr">#></span> 5 5 </span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">mdsg</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">mdsg</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> <mkindsg> holding 5 mkinds objects</span> <span class="r-out co"><span class="r-pr">#></span> Title $title: Experimental X </span> <span class="r-out co"><span class="r-pr">#></span> Occurrence of observed compounds $observed_n:</span> @@ -249,7 +256,7 @@ or covariates like soil pH).</p></dd> <span class="r-out co"><span class="r-pr">#></span> With a maximum of 2 replicates</span> <span class="r-out co"><span class="r-pr">#></span> Time unit: days </span> <span class="r-out co"><span class="r-pr">#></span> Observation unit: \%AR </span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">mdsg</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, data <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">mdsg</span>, verbose <span class="op">=</span> <span class="cn">TRUE</span>, data <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> <mkindsg> holding 5 mkinds objects</span> <span class="r-out co"><span class="r-pr">#></span> Title $title: Experimental X </span> <span class="r-out co"><span class="r-pr">#></span> Occurrence of observed compounds $observed_n:</span> @@ -391,7 +398,7 @@ or covariates like soil pH).</p></dd> <span class="r-out co"><span class="r-pr">#></span> 14 91 46.7 13.2</span> <span class="r-out co"><span class="r-pr">#></span> 15 120 42.1 14.3</span> <span class="r-out co"><span class="r-pr">#></span> 16 120 41.3 12.1</span> -<span class="r-in"></span> +<span class="r-in"><span></span></span> </code></pre></div> </div> </div> @@ -406,7 +413,7 @@ or covariates like soil pH).</p></dd> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.5.</p> </div> </footer></div> |