diff options
| author | Johannes Ranke <johannes.ranke@jrwb.de> | 2026-07-03 11:51:32 +0200 |
|---|---|---|
| committer | Johannes Ranke <johannes.ranke@jrwb.de> | 2026-07-03 11:51:32 +0200 |
| commit | 88027b7a70510b48bd7525ffcd536f0808d263e7 (patch) | |
| tree | 94f83bd420d494334011ff8f67a27483130fe857 /docs/reference/ppp.html | |
| parent | 32caaedcc6b6b8addc9f23fce9dca4188f692fed (diff) | |
Improve description with README text
Also, read the description into the Readme to have them
in sync and update docs with roxygen 8.
Diffstat (limited to 'docs/reference/ppp.html')
| -rw-r--r-- | docs/reference/ppp.html | 49 |
1 files changed, 21 insertions, 28 deletions
diff --git a/docs/reference/ppp.html b/docs/reference/ppp.html index 29ce898..fb10259 100644 --- a/docs/reference/ppp.html +++ b/docs/reference/ppp.html @@ -9,7 +9,7 @@ product"></head><body> <a class="navbar-brand me-2" href="../index.html">chents</a> - <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.4.1</small> + <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.4.2</small> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> @@ -51,23 +51,23 @@ product</p> <dd><p>The name of the product</p></dd> -<dt><code>ais</code></dt> + <dt><code>ais</code></dt> <dd><p>A list of active ingredients</p></dd> -<dt><code>concentrations</code></dt> + <dt><code>concentrations</code></dt> <dd><p>The concentration of the ais</p></dd> -<dt><code>concentration_units</code></dt> + <dt><code>concentration_units</code></dt> <dd><p>Defaults to g/L</p></dd> -<dt><code>density</code></dt> + <dt><code>density</code></dt> <dd><p>The density of the product</p></dd> -<dt><code>density_units</code></dt> + <dt><code>density_units</code></dt> <dd><p>Defaults to g/L</p></dd> @@ -78,11 +78,10 @@ product</p> <div class="section"> <h3 id="public-methods">Public methods<a class="anchor" aria-label="anchor" href="#public-methods"></a></h3> - -<ul><li><p><a href="#method-ppp-new"><code>ppp$new()</code></a></p></li> +<p></p><ul><li><p><a href="#method-ppp-initialize"><code>ppp$new()</code></a></p></li> <li><p><a href="#method-ppp-clone"><code>ppp$clone()</code></a></p></li> -</ul></div><p></p><hr><a id="method-ppp-new"></a><div class="section"> -<h3 id="method-new-">Method <code>new()</code><a class="anchor" aria-label="anchor" href="#method-new-"></a></h3> +</ul></div><p></p><hr><a id="method-ppp-initialize"></a><div class="section"> +<h3 id="ppp-new-"><code>ppp$new()</code><a class="anchor" aria-label="anchor" href="#ppp-new-"></a></h3> <p>Creates a new instance of this <a href="https://r6.r-lib.org/reference/R6Class.html" class="external-link">R6</a> class.</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><span class="va"><a href="../reference/ppp.html">ppp</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span></span> @@ -93,45 +92,38 @@ product</p> <span> density <span class="op">=</span> <span class="fl">1000</span>,</span> <span> density_units <span class="op">=</span> <span class="st">"g/L"</span></span> <span><span class="op">)</span></span></code></pre></div><p></p></div> -</div> - -<div class="section"> +</div><p></p><div class="section"> <h4 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h4> <p></p><div class="arguments"><dl><dt><code>name</code></dt> <dd><p>The name of the product</p></dd> - -<dt><code>...</code></dt> + <dt><code>...</code></dt> <dd><p>Identifiers of the active ingredients</p></dd> - -<dt><code>concentrations</code></dt> + <dt><code>concentrations</code></dt> <dd><p>Concentrations of the active ingredients</p></dd> - -<dt><code>concentration_units</code></dt> + <dt><code>concentration_units</code></dt> <dd><p>Defaults to g/L</p></dd> - -<dt><code>density</code></dt> + <dt><code>density</code></dt> <dd><p>The density</p></dd> - -<dt><code>density_units</code></dt> + <dt><code>density_units</code></dt> <dd><p>Defaults to g/L</p></dd> </dl><p></p></div> </div> -</div><p></p><hr><a id="method-ppp-clone"></a><div class="section"> -<h3 id="method-clone-">Method <code>clone()</code><a class="anchor" aria-label="anchor" href="#method-clone-"></a></h3> +</div> + +<p></p><hr><a id="method-ppp-clone"></a><div class="section"> +<h3 id="ppp-clone-"><code>ppp$clone()</code><a class="anchor" aria-label="anchor" href="#ppp-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><span class="va">ppp</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"> +</div><p></p><div class="section"> <h4 id="arguments-1">Arguments<a class="anchor" aria-label="anchor" href="#arguments-1"></a></h4> <p></p><div class="arguments"><dl><dt><code>deep</code></dt> <dd><p>Whether to make a deep clone.</p></dd> @@ -142,6 +134,7 @@ product</p> </div> + </div> </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2> |