aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/pai.html
blob: 2448b605ac545f47883b09b82333745d0510281d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<!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.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="">0.3.2</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <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/" class="external-link">
    <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/HEAD/R/chent.R" class="external-link"><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>


    <div id="format">
    <h2>Format</h2>
    <p>An <code>R6Class</code> generator object</p>
    </div>
    <div id="super-class">
    <h2>Super class</h2>
    <p><code><a href="chent.html">chents::chent</a></code> -&gt; <code>pai</code></p>
    </div>
    <div id="public-fields">
    <h2>Public fields</h2>
    <p></p><div class="r6-fields"><dl><dt><code>iso</code></dt>
<dd><p>ISO common name of the active ingredient according to ISO 1750</p></dd>


<dt><code>bcpc</code></dt>
<dd><p>Information retrieved from the BCPC compendium available online
at &lt;pesticidecompendium.bcpc.org&gt;
Creates a new instance of this <a href="https://r6.r-lib.org/reference/R6Class.html" class="external-link">R6</a> class.</p></dd>


</dl><p></p></div>
    </div>
    <div id="methods">
    <h2>Methods</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-pai-new"><code>pai$new()</code></a></p></li>
<li><p><a href="#method-pai-clone"><code>pai$clone()</code></a></p></li>
</ul></div><p><details><summary>Inherited methods</summary><ul><li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_PUF"><a href="chent.html#method-add_PUF"><code>chents::chent$add_PUF()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_TP"><a href="chent.html#method-add_TP"><code>chents::chent$add_TP()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_cwsat"><a href="chent.html#method-add_cwsat"><code>chents::chent$add_cwsat()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_p0"><a href="chent.html#method-add_p0"><code>chents::chent$add_p0()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_degradation"><a href="chent.html#method-add_soil_degradation"><code>chents::chent$add_soil_degradation()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_ff"><a href="chent.html#method-add_soil_ff"><code>chents::chent$add_soil_ff()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_soil_sorption"><a href="chent.html#method-add_soil_sorption"><code>chents::chent$add_soil_sorption()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="add_transformation"><a href="chent.html#method-add_transformation"><code>chents::chent$add_transformation()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="emf"><a href="chent.html#method-emf"><code>chents::chent$emf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_chyaml"><a href="chent.html#method-get_chyaml"><code>chents::chent$get_chyaml()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_pubchem"><a href="chent.html#method-get_pubchem"><code>chents::chent$get_pubchem()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="get_rdkit"><a href="chent.html#method-get_rdkit"><code>chents::chent$get_rdkit()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="pdf"><a href="chent.html#method-pdf"><code>chents::chent$pdf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="png"><a href="chent.html#method-png"><code>chents::chent$png()</code></a></span></li>
<li><span class="pkg-link" data-pkg="chents" data-topic="chent" data-id="try_pubchem"><a href="chent.html#method-try_pubchem"><code>chents::chent$try_pubchem()</code></a></span></li>
</ul></details></p><hr><a id="method-pai-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>This class is derived from <a href="chent.html">chent</a>. It makes it easy
to create a <a href="chent.html">chent</a> from the ISO common name of a pesticide active
ingredient, and additionally stores the ISO name as well as
the complete result of querying the BCPC compendium using
<a href="https://docs.ropensci.org/webchem/reference/bcpc_query.html" class="external-link">bcpc_query</a>.</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/pai.html">pai</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span></span>
<span>  <span class="va">iso</span>,</span>
<span>  identifier <span class="op">=</span> <span class="va">iso</span>,</span>
<span>  smiles <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  inchikey <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  bcpc <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  pubchem <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  pubchem_from <span class="op">=</span> <span class="st">"auto"</span>,</span>
<span>  rdkit <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  template <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  chyaml <span class="op">=</span> <span class="cn">TRUE</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>iso</code></dt>
<dd><p>The ISO common name to be used in the query of the
BCPC compendium</p></dd>


<dt><code>identifier</code></dt>
<dd><p>Alternative identifier used for querying pubchem</p></dd>


</dl><p></p></div>
</div>

</div><p></p><hr><a id="method-pai-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">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></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>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># On Travis, we get a certificate validation error,</span></span></span>
<span class="r-in"><span><span class="co"># likely because the system (xenial) is so old,</span></span></span>
<span class="r-in"><span><span class="co"># therefore don't run this example on Travis</span></span></span>
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/Sys.getenv.html" class="external-link">Sys.getenv</a></span><span class="op">(</span><span class="st">"TRAVIS"</span><span class="op">)</span> <span class="op">==</span> <span class="st">""</span><span class="op">)</span> <span class="op">{</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">atr</span> <span class="op">&lt;-</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></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">atr</span><span class="op">)</span></span></span>
<span class="r-in"><span><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" class="external-link">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></span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">atr</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> BCPC:</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> PubChem:</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Trying to get chemical information from RDKit using PubChem_Canonical SMILES</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> CCNC1=NC(=NC(=N1)Cl)NC(C)C</span>
<span class="r-msg co"><span class="r-pr">#&gt;</span> Did not find chyaml file ./atrazine.yaml</span>
<span class="r-plt img"><img src="pai-1.png" alt="" width="700" height="433"></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;pai&gt; with ISO common name $iso atrazine </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> &lt;chent&gt;</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Identifier $identifier atrazine </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> InChI Key $inchikey MXWJVTOOROXGIU-UHFFFAOYSA-N </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> SMILES string $smiles:</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>            PubChem_Canonical </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> "CCNC1=NC(=NC(=N1)Cl)NC(C)C" </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> Molecular weight $mw: 215.7 </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> PubChem synonyms (up to 10):</span>
<span class="r-out co"><span class="r-pr">#&gt;</span>  [1] "atrazine"     "1912-24-9"    "Gesaprim"     "Oleogesaprim" "Aktikon"     </span>
<span class="r-out co"><span class="r-pr">#&gt;</span>  [6] "Atranex"      "Chromozin"    "Atazinax"     "Atrasine"     "Gesoprim"    </span>
</code></pre></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>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown">
  <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>

  


  

  </body></html>

Contact - Imprint