diff options
Diffstat (limited to 'docs/reference/ppp.html')
-rw-r--r-- | docs/reference/ppp.html | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/docs/reference/ppp.html b/docs/reference/ppp.html new file mode 100644 index 0000000..f7b7705 --- /dev/null +++ b/docs/reference/ppp.html @@ -0,0 +1,166 @@ +<!DOCTYPE html> +<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>R6 class for a plant protection product with at least one active ingredient — ppp • chents</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="R6 class for a plant protection product with at least one active ingredient — ppp"><meta name="description" content="Contains basic information about the active ingredients in the +product"><meta property="og:description" content="Contains basic information about the active ingredients in the +product"></head><body> + <a href="#main" class="visually-hidden-focusable">Skip to contents</a> + + + <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container"> + + <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.3.7</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"> + <span class="navbar-toggler-icon"></span> + </button> + + <div id="navbar" class="collapse navbar-collapse ms-3"> + <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li> +<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li> + </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search"> + <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li> +<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jranke/chents/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li> + </ul></div> + + + </div> +</nav><div class="container template-reference-topic"> +<div class="row"> + <main id="main" class="col-md-9"><div class="page-header"> + + <h1>R6 class for a plant protection product with at least one active ingredient</h1> + <small class="dont-index">Source: <a href="https://github.com/jranke/chents/blob/HEAD/R/chent.R" class="external-link"><code>R/chent.R</code></a></small> + <div class="d-none name"><code>ppp.Rd</code></div> + </div> + + <div class="ref-description section level2"> + <p>Contains basic information about the active ingredients in the +product</p> + </div> + + + <div class="section level2"> + <h2 id="format">Format<a class="anchor" aria-label="anchor" href="#format"></a></h2> + <p>An <code>R6Class</code> generator object.</p> + </div> + <div class="section level2"> + <h2 id="public-fields">Public fields<a class="anchor" aria-label="anchor" href="#public-fields"></a></h2> + <p></p><div class="r6-fields"><dl><dt><code>name</code></dt> +<dd><p>The name of the product</p></dd> + + +<dt><code>ais</code></dt> +<dd><p>A list of active ingredients</p></dd> + + +<dt><code>concentrations</code></dt> +<dd><p>The concentration of the ais</p></dd> + + +<dt><code>concentration_units</code></dt> +<dd><p>Defaults to g/L</p></dd> + + +<dt><code>density</code></dt> +<dd><p>The density of the product</p></dd> + + +<dt><code>density_units</code></dt> +<dd><p>Defaults to g/L</p></dd> + + +</dl><p></p></div> + </div> + <div class="section level2"> + <h2 id="methods">Methods<a class="anchor" aria-label="anchor" href="#methods"></a></h2> + +<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> +<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> +<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> +<span> <span class="va">name</span>,</span> +<span> <span class="va">...</span>,</span> +<span> <span class="va">concentrations</span>,</span> +<span> concentration_units <span class="op">=</span> <span class="st">"g/L"</span>,</span> +<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"> +<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> +<dd><p>Identifiers of the active ingredients</p></dd> + + +<dt><code>concentrations</code></dt> +<dd><p>Concentrations of the active ingredients</p></dd> + + +<dt><code>concentration_units</code></dt> +<dd><p>Defaults to g/L</p></dd> + + +<dt><code>density</code></dt> +<dd><p>The density</p></dd> + + +<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> +<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"> +<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> + + +</dl><p></p></div> +</div> + +</div> + + </div> + + </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2> + </nav></aside></div> + + + <footer><div class="pkgdown-footer-left"> + <p>Developed by Johannes Ranke.</p> +</div> + +<div class="pkgdown-footer-right"> + <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p> +</div> + + </footer></div> + + + + + + </body></html> + |