diff options
| author | Ranke Johannes <johannes.ranke@agroscope.admin.ch> | 2023-11-10 18:40:34 +0100 |
|---|---|---|
| committer | Ranke Johannes <johannes.ranke@agroscope.admin.ch> | 2023-11-10 19:21:11 +0100 |
| commit | 816de01ce642c1c3d633ffb1cbcf960036d27114 (patch) | |
| tree | cf732b6e18bcc0864b481f804a1cb0b16bdd7d4d /docs/reference/plot.chent.html | |
| parent | 67384ac3c7c0b888d67d06473f81e46d520a7dd3 (diff) | |
Make an RStudio project and improve the docs
Diffstat (limited to 'docs/reference/plot.chent.html')
| -rw-r--r-- | docs/reference/plot.chent.html | 190 |
1 files changed, 62 insertions, 128 deletions
diff --git a/docs/reference/plot.chent.html b/docs/reference/plot.chent.html index 62bf38f..470ce79 100644 --- a/docs/reference/plot.chent.html +++ b/docs/reference/plot.chent.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>Plot method for chent objects — plot.chent • 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="Plot method for chent objects — plot.chent" /> -<meta property="og:description" content="Plot method for chent objects" /> - - - - -<!-- 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>Plot method for chent objects — plot.chent • 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="Plot method for chent objects — plot.chent"><meta property="og:description" content="Plot method for chent objects"><!-- 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]--> - +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + - - </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"> + <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>Plot method for chent objects</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>plot.chent.Rd</code></div> </div> @@ -117,68 +49,70 @@ <p>Plot method for chent objects</p> </div> - <pre class="usage"><span class='co'># S3 method for chent</span> -<span class='fu'><a href='https://rdrr.io/r/graphics/plot.default.html'>plot</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='va'>...</span><span class='op'>)</span></pre> - - <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> - <table class="ref-arguments"> - <colgroup><col class="name" /><col class="desc" /></colgroup> - <tr> - <th>x</th> - <td><p>The chent object to be plotted</p></td> - </tr> - <tr> - <th>...</th> - <td><p>Further arguments passed to <code>grid.picture</code></p></td> - </tr> - </table> - - - <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'><span class='va'>caffeine</span> <span class='op'><-</span> <span class='va'><a href='chent.html'>chent</a></span><span class='op'>$</span><span class='fu'>new</span><span class='op'>(</span><span class='st'>"caffeine"</span><span class='op'>)</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'>CN1C=NC2=C1C(=O)N(C(=O)N2C)C</span></div><div class='output co'>#> <span class='message'>Did not find chyaml file ./caffeine.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'>caffeine</span><span class='op'>)</span> -</div><div class='output co'>#> <chent> -#> Identifier $identifier caffeine -#> InChI Key $inchikey RYYVLZVUVIJVGH-UHFFFAOYSA-N -#> SMILES string $smiles: -#> PubChem_Canonical -#> "CN1C=NC2=C1C(=O)N(C(=O)N2C)C" -#> Molecular weight $mw: 194.2 -#> PubChem synonyms (up to 10): -#> [1] "caffeine" "58-08-2" -#> [3] "1,3,7-Trimethylxanthine" "Guaranine" -#> [5] "Thein" "Methyltheobromine" -#> [7] "Cafeina" "Theine" -#> [9] "Koffein" "Mateina" </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'>caffeine</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'>caffeine</span><span class='op'>)</span> -<span class='op'>}</span> -</div><div class='img'><img src='plot.chent-1.png' alt='' width='700' height='433' /></div></pre> + <div id="ref-usage"> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for chent</span></span> +<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">x</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div> + </div> + + <div id="arguments"> + <h2>Arguments</h2> + <dl><dt>x</dt> +<dd><p>The chent object to be plotted</p></dd> + + +<dt>...</dt> +<dd><p>Further arguments passed to <code>grid.picture</code></p></dd> + +</dl></div> + + <div id="ref-examples"> + <h2>Examples</h2> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">caffeine</span> <span class="op"><-</span> <span class="va"><a href="chent.html">chent</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span><span class="st">"caffeine"</span><span class="op">)</span></span></span> +<span class="r-msg co"><span class="r-pr">#></span> PubChem:</span> +<span class="r-msg co"><span class="r-pr">#></span> Trying to get chemical information from RDKit using PubChem_Canonical SMILES</span> +<span class="r-msg co"><span class="r-pr">#></span> CN1C=NC2=C1C(=O)N(C(=O)N2C)C</span> +<span class="r-msg co"><span class="r-pr">#></span> Did not find chyaml file ./caffeine.yaml</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">caffeine</span><span class="op">)</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> <chent></span> +<span class="r-out co"><span class="r-pr">#></span> Identifier $identifier caffeine </span> +<span class="r-out co"><span class="r-pr">#></span> InChI Key $inchikey RYYVLZVUVIJVGH-UHFFFAOYSA-N </span> +<span class="r-out co"><span class="r-pr">#></span> SMILES string $smiles:</span> +<span class="r-out co"><span class="r-pr">#></span> PubChem_Canonical </span> +<span class="r-out co"><span class="r-pr">#></span> "CN1C=NC2=C1C(=O)N(C(=O)N2C)C" </span> +<span class="r-out co"><span class="r-pr">#></span> Molecular weight $mw: 194.2 </span> +<span class="r-out co"><span class="r-pr">#></span> PubChem synonyms (up to 10):</span> +<span class="r-out co"><span class="r-pr">#></span> [1] "caffeine" "58-08-2" </span> +<span class="r-out co"><span class="r-pr">#></span> [3] "Guaranine" "1,3,7-Trimethylxanthine"</span> +<span class="r-out co"><span class="r-pr">#></span> [5] "Methyltheobromine" "Theine" </span> +<span class="r-out co"><span class="r-pr">#></span> [7] "Thein" "Cafeina" </span> +<span class="r-out co"><span class="r-pr">#></span> [9] "Koffein" "Mateina" </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">caffeine</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">caffeine</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="op">}</span></span></span> +<span class="r-plt img"><img src="plot.chent-1.png" alt="" width="700" height="433"></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> + <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> |