aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/pp.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/pp.html')
-rw-r--r--docs/reference/pp.html120
1 files changed, 84 insertions, 36 deletions
diff --git a/docs/reference/pp.html b/docs/reference/pp.html
index aa660cb..c4e4a01 100644
--- a/docs/reference/pp.html
+++ b/docs/reference/pp.html
@@ -8,21 +8,29 @@
<title>R6 class for holding a product with at least one active ingredient — pp • chents</title>
+
<!-- jquery -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
-<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
+
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
+
+<!-- bootstrap-toc -->
+<link rel="stylesheet" href="../bootstrap-toc.css">
+<script src="../bootstrap-toc.js"></script>
<!-- Font Awesome icons -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
<!-- clipboard.js -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
-<!-- sticky kit -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
+<!-- headroom.js -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
@@ -30,10 +38,10 @@
-<meta property="og:title" content="R6 class for holding a product with at least one active ingredient — pp" />
+<meta property="og:title" content="R6 class for holding a product with at least one active ingredient — pp" />
<meta property="og:description" content="An R6 class for holding information about a product with at least one active ingredient" />
-<meta name="twitter:card" content="summary" />
+
@@ -47,9 +55,10 @@
<![endif]-->
+
</head>
- <body>
+ <body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
@@ -63,7 +72,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">chents</a>
- <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.2.7</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.3.1</span>
</span>
</div>
@@ -71,7 +80,7 @@
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
- <span class="fa fa-home fa-lg"></span>
+ <span class="fas fa-home fa-lg"></span>
</a>
</li>
@@ -79,11 +88,10 @@
<a href="../reference/index.html">Reference</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
<li>
- <a href="https://github.com/jranke/chents">
- <span class="fa fa-github fa-lg"></span>
+ <a href="https://github.com/jranke/chents/">
+ <span class="fab fa-github fa-lg"></span>
</a>
</li>
@@ -94,6 +102,7 @@
</div><!--/.navbar -->
+
</header>
<div class="row">
@@ -105,54 +114,93 @@
</div>
<div class="ref-description">
-
<p>An R6 class for holding information about a product with at least one active ingredient</p>
-
</div>
- <pre class="usage"><span class='no'>pp</span></pre>
-
+
+
<h2 class="hasAnchor" id="format"><a class="anchor" href="#format"></a>Format</h2>
<p>An <code>R6Class</code> generator object.</p>
-
- <h2 class="hasAnchor" id="fields"><a class="anchor" href="#fields"></a>Fields</h2>
+ <h2 class="hasAnchor" id="public-fields"><a class="anchor" href="#public-fields"></a>Public fields</h2>
-
- <dl class='dl-horizontal'>
+ <p><div class="r6-fields"></p><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>
-</dl>
+
+<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>
+
+</dl><p></div></p>
+ <h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2>
+
+<h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Public methods</h3>
- </div>
- <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
- <h2>Contents</h2>
- <ul class="nav nav-pills nav-stacked">
-
- <li><a href="#format">Format</a></li>
+<ul>
+<li><p><a href='#method-new'><code>pp$new()</code></a></p></li>
+<li><p><a href='#method-print'><code>pp$print()</code></a></p></li>
+<li><p><a href='#method-clone'><code>pp$clone()</code></a></p></li>
+</ul>
+<p><hr>
+<a id="method-new"></a></p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Method <code>new()</code></h3>
+
+<h4 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Usage</h4>
+<p><div class="r"></p><pre><span class='va'>pp</span><span class='op'>$</span><span class='fu'>new</span><span class='op'>(</span>
+ <span class='va'>name</span>,
+ <span class='va'>...</span>,
+ <span class='va'>concentrations</span>,
+ concentration_units <span class='op'>=</span> <span class='st'>"g/L"</span>,
+ density <span class='op'>=</span> <span class='fl'>1000</span>,
+ density_units <span class='op'>=</span> <span class='st'>"g/L"</span>
+<span class='op'>)</span></pre><p></div></p>
+
+<p><hr>
+<a id="method-print"></a></p><h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>
+
+<h4 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Usage</h4>
+<p><div class="r"></p><pre><span class='va'>pp</span><span class='op'>$</span><span class='fu'>print</span><span class='op'>(</span><span class='op'>)</span></pre><p></div></p>
+
+<p><hr>
+<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'>pp</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>
- <li><a href="#fields">Fields</a></li>
- </ul>
+<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>
+
+
+
+ </div>
+ <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
+ <nav id="toc" data-toggle="toc" class="sticky-top">
+ <h2 data-toc-skip>Contents</h2>
+ </nav>
</div>
</div>
+
<footer>
<div class="copyright">
<p>Developed by Johannes Ranke.</p>
</div>
<div class="pkgdown">
- <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
+ <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
</div>
+
</footer>
</div>
+
</body>
</html>
+

Contact - Imprint