blob: e5ecb99ca8368767f8e3af166981d05771b36992 (
plain) (
tree)
|
|
<!-- 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>An R6 class for pesticidal active ingredients and associated data — pai • 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="An R6 class for pesticidal active ingredients and associated data — pai" />
<meta property="og:description" content="The class is initialised with an identifier which is generally an ISO common name.
Additional chemical information is retrieved from the internet if available." />
<!-- 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>
<body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<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">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</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>
</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>
<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="fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>An R6 class for pesticidal active ingredients and associated data</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>
<div class="hidden name"><code>pai.Rd</code></div>
</div>
<div class="ref-description">
<p>The class is initialised with an identifier which is generally an ISO common name.
Additional chemical information is retrieved from the internet if available.</p>
</div>
<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="super-class"><a class="anchor" href="#super-class"></a>Super class</h2>
<p><code><a href='chent.html'>chents::chent</a></code> -> <code>pai</code></p>
<h2 class="hasAnchor" id="public-fields"><a class="anchor" href="#public-fields"></a>Public fields</h2>
<p><div class="r6-fields"></p><dl>
<dt><code>iso</code></dt><dd><p>ISO common name according to ISO 1750 as retreived from pesticidecompendium.bcpc.org</p></dd>
<dt><code>bcpc</code></dt><dd><p>List of information retrieved from pesticidecompendium.bcpc.org</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>
<ul>
<li><p><a href='#method-new'><code>pai$new()</code></a></p></li>
<li><p><a href='#method-clone'><code>pai$clone()</code></a></p></li>
</ul>
<p><details ><summary>Inherited methods</summary>
<ul>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_PUF"><a href='../../chents/html/chent.html#method-add_PUF'><code>chents::chent$add_PUF()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_TP"><a href='../../chents/html/chent.html#method-add_TP'><code>chents::chent$add_TP()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_cwsat"><a href='../../chents/html/chent.html#method-add_cwsat'><code>chents::chent$add_cwsat()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_p0"><a href='../../chents/html/chent.html#method-add_p0'><code>chents::chent$add_p0()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_degradation"><a href='../../chents/html/chent.html#method-add_soil_degradation'><code>chents::chent$add_soil_degradation()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_ff"><a href='../../chents/html/chent.html#method-add_soil_ff'><code>chents::chent$add_soil_ff()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_sorption"><a href='../../chents/html/chent.html#method-add_soil_sorption'><code>chents::chent$add_soil_sorption()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_transformation"><a href='../../chents/html/chent.html#method-add_transformation'><code>chents::chent$add_transformation()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="emf"><a href='../../chents/html/chent.html#method-emf'><code>chents::chent$emf()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_chyaml"><a href='../../chents/html/chent.html#method-get_chyaml'><code>chents::chent$get_chyaml()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_pubchem"><a href='../../chents/html/chent.html#method-get_pubchem'><code>chents::chent$get_pubchem()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_rdkit"><a href='../../chents/html/chent.html#method-get_rdkit'><code>chents::chent$get_rdkit()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="pdf"><a href='../../chents/html/chent.html#method-pdf'><code>chents::chent$pdf()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="png"><a href='../../chents/html/chent.html#method-png'><code>chents::chent$png()</code></a></span></p></li>
<li><p><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="try_pubchem"><a href='../../chents/html/chent.html#method-try_pubchem'><code>chents::chent$try_pubchem()</code></a></span></p></li>
</ul>
</details>
<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'>pai</span><span class='op'>$</span><span class='fu'>new</span><span class='op'>(</span>
<span class='va'>iso</span>,
identifier <span class='op'>=</span> <span class='va'>iso</span>,
smiles <span class='op'>=</span> <span class='cn'>NULL</span>,
smiles_source <span class='op'>=</span> <span class='st'>"user"</span>,
inchikey <span class='op'>=</span> <span class='cn'>NULL</span>,
inchikey_source <span class='op'>=</span> <span class='st'>"user"</span>,
bcpc <span class='op'>=</span> <span class='cn'>TRUE</span>,
pubchem <span class='op'>=</span> <span class='cn'>TRUE</span>,
pubchem_from <span class='op'>=</span> <span class='st'>"auto"</span>,
rdkit <span class='op'>=</span> <span class='cn'>TRUE</span>,
template <span class='op'>=</span> <span class='cn'>NULL</span>,
chyaml <span class='op'>=</span> <span class='cn'>TRUE</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'>pai</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>
<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>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='va'>atr</span> <span class='op'><-</span> <span class='va'>pai</span><span class='op'>$</span><span class='fu'>new</span><span class='op'>(</span><span class='st'>"atrazine"</span><span class='op'>)</span>
</div><div class='output co'>#> <span class='message'>BCPC:</span></div><div class='output co'>#> <span class='message'>PubChem:</span></div><div class='output co'>#> <span class='message'>Trying to get chemical information from RDKit using PubChem_Canonical SMILES</span>
#> <span class='message'>CCNC1=NC(=NC(=N1)Cl)NC(C)C</span></div><div class='output co'>#> <span class='message'>Did not find chyaml file ./atrazine.yaml</span></div><div class='input'><span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span><span class='op'>(</span><span class='va'>atr</span><span class='op'>)</span>
</div><div class='output co'>#> <pai> with ISO common name $iso atrazine
#> <chent>
#> Identifier $identifier atrazine
#> InChI Key $inchikey MXWJVTOOROXGIU-UHFFFAOYSA-N
#> SMILES string $smiles:
#> PubChem_Canonical
#> "CCNC1=NC(=NC(=N1)Cl)NC(C)C"
#> Molecular weight $mw: 215.7
#> PubChem synonyms (up to 10):
#> [1] "atrazine" "1912-24-9" "Gesaprim" "Oleogesaprim" "Chromozin"
#> [6] "Aktikon" "Atrazin" "Argezin" "Atazinax" "Atranex" </div><div class='input'><span class='kw'>if</span> <span class='op'>(</span><span class='op'>!</span><span class='fu'><a href='https://rdrr.io/r/base/NULL.html'>is.null</a></span><span class='op'>(</span><span class='va'>atr</span><span class='op'>$</span><span class='va'>Picture</span><span class='op'>)</span><span class='op'>)</span> <span class='op'>{</span>
<span class='fu'><a href='https://rdrr.io/r/graphics/plot.default.html'>plot</a></span><span class='op'>(</span><span class='va'>atr</span><span class='op'>)</span>
<span class='op'>}</span>
</div><div class='img'><img src='pai-1.png' alt='' width='700' height='433' /></div></pre>
</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.6.1.</p>
</div>
</footer>
</div>
</body>
</html>
|
