aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/reference/mkinds.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2020-11-19 15:41:24 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2020-11-19 15:41:24 +0100
commitdb9ae6a0c9cecb92048fde6f06af1da183c09b5f (patch)
treef0ea97545549c71bd7aa3d13afed422fd402f0e6 /docs/dev/reference/mkinds.html
parent6441a9f35d66f2c4d38c0036f99cd8f509d76f3b (diff)
Depend on parallel, doc improvements
By depending on parallel instead of importing it, functions to set up and stop a cluster are always available when mkin is loaded. The use of multicore processing in mmkin on Windows is now documented in the help file, which brings mkin closer to a version 1.0 #9.
Diffstat (limited to 'docs/dev/reference/mkinds.html')
-rw-r--r--docs/dev/reference/mkinds.html63
1 files changed, 40 insertions, 23 deletions
diff --git a/docs/dev/reference/mkinds.html b/docs/dev/reference/mkinds.html
index a8641375..907f8ad3 100644
--- a/docs/dev/reference/mkinds.html
+++ b/docs/dev/reference/mkinds.html
@@ -75,7 +75,7 @@ provided by this package come as mkinds objects nevertheless." />
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">mkin</a>
- <span class="version label label-info" data-toggle="tooltip" data-placement="bottom" title="In-development version">0.9.50.3</span>
+ <span class="version label label-info" data-toggle="tooltip" data-placement="bottom" title="In-development version">0.9.50.4</span>
</span>
</div>
@@ -123,7 +123,7 @@ provided by this package come as mkinds objects nevertheless." />
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
- <a href="http://github.com/jranke/mkin/">
+ <a href="https://github.com/jranke/mkin/">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
@@ -142,7 +142,7 @@ provided by this package come as mkinds objects nevertheless." />
<div class="col-md-9 contents">
<div class="page-header">
<h1>A dataset class for mkin</h1>
- <small class="dont-index">Source: <a href='http://github.com/jranke/mkin/blob/master/R/mkinds.R'><code>R/mkinds.R</code></a></small>
+ <small class="dont-index">Source: <a href='https://github.com/jranke/mkin/blob/master/R/mkinds.R'><code>R/mkinds.R</code></a></small>
<div class="hidden name"><code>mkinds.Rd</code></div>
</div>
@@ -153,14 +153,29 @@ such as the on contained in the data field of mkinds objects. Some datasets
provided by this package come as mkinds objects nevertheless.</p>
</div>
+ <pre class="usage"><span class='co'># S3 method for mkinds</span>
+<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span><span class='op'>(</span><span class='va'>x</span>, data <span class='op'>=</span> <span class='cn'>FALSE</span>, <span class='va'>...</span><span class='op'>)</span></pre>
+
+ <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
+ <table class="ref-arguments">
+ <colgroup><col class="name" /><col class="desc" /></colgroup>
+ <tr>
+ <th>x</th>
+ <td><p>An mkinds object.</p></td>
+ </tr>
+ <tr>
+ <th>data</th>
+ <td><p>Should the data be printed?</p></td>
+ </tr>
+ <tr>
+ <th>...</th>
+ <td><p>Not used.</p></td>
+ </tr>
+ </table>
-
- <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
-
- <div class='dont-index'><p>The S3 printing method <code><a href='print.mkinds.html'>print.mkinds</a></code></p></div>
<h2 class="hasAnchor" id="public-fields"><a class="anchor" href="#public-fields"></a>Public fields</h2>
- <p><div class="r6-fields"></p><dl'>
+ <p><div class="r6-fields"></p><dl>
<dt><code>title</code></dt><dd><p>A full title for the dataset</p></dd>
<dt><code>sampling_times</code></dt><dd><p>The sampling times</p></dd>
@@ -180,19 +195,19 @@ and value in order to be compatible with mkinfit</p></dd>
<h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2>
-<h3>Public methods</h3>
+<h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Public methods</h3>
<ul>
<li><p><a href='#method-new'><code>mkinds$new()</code></a></p></li>
<li><p><a href='#method-clone'><code>mkinds$clone()</code></a></p></li>
</ul>
<p><hr>
-<a id="method-new"></a></p><h3>Method <code>new()</code></h3>
-<p>Create a new mkinds object</p><h3>Usage</h3>
-<p><div class="r"></p><pre><span class='no'>mkinds</span>$<span class='fu'>new</span>(<span class='kw'>title</span> <span class='kw'>=</span> <span class='st'>""</span>, <span class='no'>data</span>, <span class='kw'>time_unit</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>unit</span> <span class='kw'>=</span> <span class='fl'>NA</span>)</pre><p></div></p>
+<a id="method-new"></a></p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Method <code>new()</code></h3>
+<p>Create a new mkinds object</p><h4 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Usage</h4>
+<p><div class="r"></p><pre><span class='va'>mkinds</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'>data</span>, time_unit <span class='op'>=</span> <span class='cn'>NA</span>, unit <span class='op'>=</span> <span class='cn'>NA</span><span class='op'>)</span></pre><p></div></p>
-<h3>Arguments</h3>
-<p><div class="arguments"></p><dl'>
+<h4 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Arguments</h4>
+<p><div class="arguments"></p><dl>
<dt><code>title</code></dt><dd><p>The dataset title</p></dd>
<dt><code>data</code></dt><dd><p>The data</p></dd>
@@ -203,12 +218,12 @@ and value in order to be compatible with mkinfit</p></dd>
</dl><p></div></p>
<p><hr>
-<a id="method-clone"></a></p><h3>Method <code>clone()</code></h3>
-<p>The objects of this class are cloneable with this method.</p><h3>Usage</h3>
-<p><div class="r"></p><pre><span class='no'>mkinds</span>$<span class='fu'>clone</span>(<span class='kw'>deep</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre><p></div></p>
+<a id="method-clone"></a></p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Method <code>clone()</code></h3>
+<p>The objects of this class are cloneable with this method.</p><h4 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Usage</h4>
+<p><div class="r"></p><pre><span class='va'>mkinds</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></pre><p></div></p>
-<h3>Arguments</h3>
-<p><div class="arguments"></p><dl'>
+<h4 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>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>
@@ -217,10 +232,12 @@ and value in order to be compatible with mkinfit</p></dd>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'>
-<span class='no'>mds</span> <span class='kw'>&lt;-</span> <span class='no'>mkinds</span>$<span class='fu'>new</span>(<span class='st'>"FOCUS A"</span>, <span class='no'>FOCUS_2006_A</span>)
-<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>(<span class='no'>mds</span>)</div><div class='output co'>#&gt; &lt;mkinds&gt; with $title: FOCUS A
+<span class='va'>mds</span> <span class='op'>&lt;-</span> <span class='va'>mkinds</span><span class='op'>$</span><span class='fu'>new</span><span class='op'>(</span><span class='st'>"FOCUS A"</span>, <span class='va'>FOCUS_2006_A</span><span class='op'>)</span>
+<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span><span class='op'>(</span><span class='va'>mds</span><span class='op'>)</span>
+</div><div class='output co'>#&gt; &lt;mkinds&gt; with $title: FOCUS A
#&gt; Observed compounds $observed: parent
-#&gt; Sampling times $sampling_times: 0, 3, 7, 14, 30, 62, 90, 118
+#&gt; Sampling times $sampling_times:
+#&gt; 0, 3, 7, 14, 30, 62, 90, 118
#&gt; With a maximum of 1 replicates</div><div class='input'>
</div></pre>
</div>
@@ -238,7 +255,7 @@ and value in order to be compatible with mkinfit</p></dd>
</div>
<div class="pkgdown">
- <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
+ <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
</div>
</footer>

Contact - Imprint