summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/index.md b/docs/index.md
index 6eb0823..b8c02f3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -9,9 +9,14 @@ coverage](https://img.shields.io/badge/coverage-jrwb.de-blue.svg)](https://pkgdo
When working with data on chemical substances, we often need a reliable
link between the data and the chemical identity of the substances. The R
-package **chents** provides a way to define an R object corresponding to
-a chemically defined substances (“chemical entity”) and to collect
-related information.
+package ‘chents’ provides a way to define an R object corresponding to a
+chemically defined substances, i.e. a chemical entity and to collect
+related information. If Python and ‘RDKit’ (\> 2015.03) are installed
+and configured for use with ‘reticulate’, some basic chemoinformatics
+functions like the calculation of molecular weight and plotting of
+chemical structures in R graphics are available.
+
+## Usage
When first defining a chemical entity, some chemical information is
retrieved from the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) website
@@ -56,7 +61,7 @@ There is a very simple plotting method for the chemical structure.
plot(caffeine)
```
-![](reference/figures/README-unnamed-chunk-4-1.png)
+![](reference/figures/README-unnamed-chunk-5-1.png)
If you have a so-called ISO common name of a pesticide active
ingredient, you can use the ‘pai’ class derived from the ‘chent’ class,
@@ -72,7 +77,7 @@ delta <- pai$new("Deltamethrin")
plot(delta)
```
-![](reference/figures/README-unnamed-chunk-5-1.png)
+![](reference/figures/README-unnamed-chunk-6-1.png)
Additional information can be read from a local .yaml file. This
information can be leveraged e.g. by the

Contact - Imprint