aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/chent.html
blob: 1608eb096da36452c708fe5334e9af6519361bb0 (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
<!-- 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 chemical entities with associated data — chent • 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>
<!-- 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>

<!-- 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" />

<!-- 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>

<!-- 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>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



<meta property="og:title" content="An R6 class for chemical entities with associated data — chent" />

<meta property="og:description" content="The class is initialised with an identifier. Chemical information is retrieved from
the internet. Additionally, it can be generated using RDKit if RDKit and its
python bindings are installed and configured for use with PythonInR." />
<meta name="twitter:card" content="summary" />



<!-- 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>
    <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.2.6</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa 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="fa 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 chemical entities with 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>chent.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>The class is initialised with an identifier. Chemical information is retrieved from
the internet. Additionally, it can be generated using RDKit if RDKit and its
python bindings are installed and configured for use with PythonInR.</p>
    
    </div>

    <pre class="usage"><span class='no'>chent</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>

    
    <dl class='dl-horizontal'>
<dt><code>identifier</code></dt><dd><p>The identifier that was used to initiate the object, with attribute 'source'</p></dd>
    <dt><code>inchikey</code></dt><dd><p>InChI Key, with attribute 'source'</p></dd>
    <dt><code>smiles</code></dt><dd><p>SMILES code, with attribute 'source'</p></dd>
    <dt><code>mw</code></dt><dd><p>Molecular weight, with attribute 'source'</p></dd>
    <dt><code>pubchem</code></dt><dd><p>List of information retreived from PubChem</p></dd>
    <dt><code>rdkit</code></dt><dd><p>List of information obtained with RDKit, if installed and
configured for use with PythonInR</p></dd>
    <dt><code>svg</code></dt><dd><p>SVG code</p></dd>
    <dt><code>Picture</code></dt><dd><p>Graph as a <code>picture</code> object obtained using grImport</p></dd>
    <dt><code>Pict_font_size</code></dt><dd><p>Font size as extracted from the intermediate PostScript file</p></dd>
    <dt><code>pdf_height</code></dt><dd><p>Height of the MediaBox in the pdf after cropping</p></dd>
    <dt><code>p0</code></dt><dd><p>Vapour pressure in Pa</p></dd>
    <dt><code>cwsat</code></dt><dd><p>Water solubility in mg/L</p></dd>
    <dt><code>chyaml</code></dt><dd><p>List of information obtained from a YAML file</p></dd>
    <dt><code>soil_degradation</code></dt><dd><p>Dataframe of modelling DT50 values</p></dd>
    <dt><code>soil_ff</code></dt><dd><p>Dataframe of formation fractions</p></dd>
    <dt><code>soil_sorption</code></dt><dd><p>Dataframe of soil sorption data</p></dd>
    <dt><code>PUF</code></dt><dd><p>Plant uptake factor</p></dd>
</dl>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'><span class='no'>oct</span> <span class='kw'>&lt;-</span> <span class='no'>chent</span>$<span class='fu'>new</span>(<span class='st'>"1-octanol"</span>, <span class='kw'>smiles</span> <span class='kw'>=</span> <span class='st'>"CCCCCCCCO"</span>)</div><div class='output co'>#&gt; <span class='message'>PubChem:</span></div><div class='output co'>#&gt; <span class='message'>https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/cids/JSON</span></div><div class='output co'>#&gt; <span class='message'>https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/cid/property/MolecularFormula,MolecularWeight,CanonicalSMILES,IsomericSMILES,InChI,InChIKey,IUPACName,XLogP,TPSA,Complexity,Charge,HBondDonorCount,HBondAcceptorCount/JSON</span></div><div class='output co'>#&gt; <span class='message'>https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/cid/synonyms/JSON</span></div><div class='output co'>#&gt; <span class='message'></span>
#&gt; <span class='message'>Initialize Python Version 2.7.13 (default, Sep 26 2018, 18:42:22) </span>
#&gt; <span class='message'>[GCC 6.3.0 20170516]</span></div><div class='output co'>#&gt; <span class='message'>Trying to get chemical information from RDKit using User SMILES</span>
#&gt; <span class='message'>CCCCCCCCO</span></div><div class='output co'>#&gt; <span class='message'>Lade nötigen Namensraum: grConvert</span></div><div class='output co'>#&gt; <span class='message'>Did not find chyaml file ./1-octanol.yaml</span></div><div class='input'><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/print'>print</a></span>(<span class='no'>oct</span>)</div><div class='output co'>#&gt; &lt;chent&gt;
#&gt; Identifier $identifier 1-octanol 
#&gt; InChI Key $inchikey KBPLFHHGFOOTCA-UHFFFAOYSA-N 
#&gt; SMILES string $smiles:
#&gt;              user PubChem_Canonical 
#&gt;       "CCCCCCCCO"       "CCCCCCCCO" 
#&gt; Molecular weight $mw: 130.2 
#&gt; PubChem synonyms (up to 10):
#&gt;  [1] "957"              "1-octanol"        "Octan-1-ol"       "octanol"         
#&gt;  [5] "111-87-5"         "N-octanol"        "Capryl alcohol"   "Octyl alcohol"   
#&gt;  [9] "caprylic alcohol" "n-Octyl alcohol" </div><div class='input'><span class='kw'>if</span> (<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/ns-load'>requireNamespace</a></span>(<span class='st'>"grConvert"</span>)) {
  <span class='fu'><a href='https://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span>(<span class='no'>oct</span>)
}</div><div class='input'><span class='no'>caffeine</span> <span class='kw'>&lt;-</span> <span class='no'>chent</span>$<span class='fu'>new</span>(<span class='st'>"caffeine"</span>)</div><div class='output co'>#&gt; <span class='message'>PubChem:</span></div><div class='output co'>#&gt; <span class='message'>https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/cids/JSON</span></div><div class='output co'>#&gt; <span class='message'>https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/cid/property/MolecularFormula,MolecularWeight,CanonicalSMILES,IsomericSMILES,InChI,InChIKey,IUPACName,XLogP,TPSA,Complexity,Charge,HBondDonorCount,HBondAcceptorCount/JSON</span></div><div class='output co'>#&gt; <span class='message'>https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/cid/synonyms/JSON</span></div><div class='output co'>#&gt; <span class='message'>Trying to get chemical information from RDKit using PubChem_Canonical SMILES</span>
#&gt; <span class='message'>CN1C=NC2=C1C(=O)N(C(=O)N2C)C</span></div><div class='output co'>#&gt; <span class='message'>Did not find chyaml file ./caffeine.yaml</span></div><div class='input'><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/print'>print</a></span>(<span class='no'>caffeine</span>)</div><div class='output co'>#&gt; &lt;chent&gt;
#&gt; Identifier $identifier caffeine 
#&gt; InChI Key $inchikey RYYVLZVUVIJVGH-UHFFFAOYSA-N 
#&gt; SMILES string $smiles:
#&gt;              PubChem_Canonical 
#&gt; "CN1C=NC2=C1C(=O)N(C(=O)N2C)C" 
#&gt; Molecular weight $mw: 194.2 
#&gt; PubChem synonyms (up to 10):
#&gt;  [1] "2519"                    "caffeine"               
#&gt;  [3] "58-08-2"                 "Guaranine"              
#&gt;  [5] "1,3,7-Trimethylxanthine" "Thein"                  
#&gt;  [7] "Cafeina"                 "Methyltheobromine"      
#&gt;  [9] "Koffein"                 "Mateina"                </div><div class='input'><span class='kw'>if</span> (<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/ns-load'>requireNamespace</a></span>(<span class='st'>"grConvert"</span>)) {
  <span class='fu'><a href='https://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span>(<span class='no'>caffeine</span>)
}</div><div class='img'><img src='chent-1.png' alt='' width='700' height='433' /></div></pre>
  </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>

      <li><a href="#fields">Fields</a></li>
      
      <li><a href="#examples">Examples</a></li>
    </ul>

  </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>
</div>
      </footer>
   </div>

  

  </body>
</html>

Contact - Imprint