aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/pp.html
diff options
context:
space:
mode:
authorRanke Johannes <johannes.ranke@agroscope.admin.ch>2023-11-10 18:40:34 +0100
committerRanke Johannes <johannes.ranke@agroscope.admin.ch>2023-11-10 19:21:11 +0100
commit816de01ce642c1c3d633ffb1cbcf960036d27114 (patch)
treecf732b6e18bcc0864b481f804a1cb0b16bdd7d4d /docs/reference/pp.html
parent67384ac3c7c0b888d67d06473f81e46d520a7dd3 (diff)
Make an RStudio project and improve the docs
Diffstat (limited to 'docs/reference/pp.html')
-rw-r--r--docs/reference/pp.html208
1 files changed, 78 insertions, 130 deletions
diff --git a/docs/reference/pp.html b/docs/reference/pp.html
index c4e4a01..2607035 100644
--- a/docs/reference/pp.html
+++ b/docs/reference/pp.html
@@ -1,67 +1,12 @@
-<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
-<meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-<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.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.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/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.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" 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">
-<script src="../pkgdown.js"></script>
-
-
-
-
-<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" />
-
-
-
-
-<!-- mathjax -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
-
-<!--[if lt IE 9]>
+<!-- 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.0"><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.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.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/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.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" 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"><script src="../pkgdown.js"></script><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"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
-<![endif]-->
-
-
-
- </head>
+<![endif]--></head><body data-spy="scroll" data-target="#toc">
+
- <body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
- <header>
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
@@ -72,44 +17,31 @@
</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.3.1</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.3.1</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
- <ul class="nav navbar-nav">
- <li>
- <a href="../index.html">
- <span class="fas fa-home fa-lg"></span>
-
- </a>
-</li>
-<li>
+ <ul class="nav navbar-nav"><li>
<a href="../reference/index.html">Reference</a>
</li>
- </ul>
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="https://github.com/jranke/chents/">
+ </ul><ul class="nav navbar-nav navbar-right"><li>
+ <a href="https://github.com/jranke/chents/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
- </ul>
-
- </div><!--/.nav-collapse -->
+ </ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
- </header>
-
-<div class="row">
+ </header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>R6 class for holding a product with at least one active ingredient</h1>
- <small class="dont-index">Source: <a href='https://github.com/jranke/chents/blob/master/R/chent.R'><code>R/chent.R</code></a></small>
+ <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="hidden name"><code>pp.Rd</code></div>
</div>
@@ -118,89 +50,105 @@
</div>
+ <div id="format">
+ <h2>Format</h2>
+ <p>An <code>R6Class</code> generator object.</p>
+ </div>
+ <div id="public-fields">
+ <h2>Public fields</h2>
+ <p></p><div class="r6-fields"><dl><dt><code>name</code></dt>
+<dd><p>The name of the product</p></dd>
- <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="public-fields"><a class="anchor" href="#public-fields"></a>Public fields</h2>
+<dt><code>ais</code></dt>
+<dd><p>A list of active ingredients</p></dd>
- <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>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>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>
+</dl><p></p></div>
+ </div>
+ <div id="methods">
+ <h2>Methods</h2>
-<h3 class='hasAnchor' id='arguments'><a class='anchor' href='#arguments'></a>Public methods</h3>
+<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-pp-new"><code>pp$new()</code></a></p></li>
+<li><p><a href="#method-pp-print"><code>pp$print()</code></a></p></li>
+<li><p><a href="#method-pp-clone"><code>pp$clone()</code></a></p></li>
+</ul></div><p></p><hr><a id="method-pp-new"></a><div class="section">
+<h3 id="method-new-">Method <code>new()</code><a class="anchor" aria-label="anchor" href="#method-new-"></a></h3>
+
+<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/pp.html">pp</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>
-<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>
+</div><p></p><hr><a id="method-pp-print"></a><div class="section">
+<h3 id="method-print-">Method <code><a href="https://rdrr.io/r/base/print.html" class="external-link">print()</a></code><a class="anchor" aria-label="anchor" href="#method-print-"></a></h3>
-<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>
+<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">pp</span><span class="op">$</span><span class="fu">print</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
+</div>
-<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>
+</div><p></p><hr><a id="method-pp-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-2">Usage<a class="anchor" aria-label="anchor" href="#usage-2"></a></h4>
+<p></p><div class="r"><div class="sourceCode"><pre><code><span><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></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>deep</code></dt>
+<dd><p>Whether to make a deep clone.</p></dd>
-<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>
+</dl><p></p></div>
+</div>
+</div>
+ </div>
</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>
+ <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>
+ <footer><div class="copyright">
+ <p></p><p>Developed by Johannes Ranke.</p>
</div>
<div class="pkgdown">
- <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
- </footer>
- </div>
+ </footer></div>
- </body>
-</html>
+
+ </body></html>

Contact - Imprint