summaryrefslogtreecommitdiff
path: root/README.rmd
diff options
context:
space:
mode:
authorJohannes Ranke <johannes.ranke@jrwb.de>2026-07-03 11:51:32 +0200
committerJohannes Ranke <johannes.ranke@jrwb.de>2026-07-03 11:51:32 +0200
commit88027b7a70510b48bd7525ffcd536f0808d263e7 (patch)
tree94f83bd420d494334011ff8f67a27483130fe857 /README.rmd
parent32caaedcc6b6b8addc9f23fce9dca4188f692fed (diff)
Improve description with README text
Also, read the description into the Readme to have them in sync and update docs with roxygen 8.
Diffstat (limited to 'README.rmd')
-rw-r--r--README.rmd8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.rmd b/README.rmd
index 89462ac..cc15d07 100644
--- a/README.rmd
+++ b/README.rmd
@@ -14,11 +14,11 @@ knitr::opts_chunk$set(
[![R-Universe status](https://jranke.r-universe.dev/badges/chents)](https://jranke.r-universe.dev/chents)
[![Code coverage](https://img.shields.io/badge/coverage-jrwb.de-blue.svg)](https://pkgdown.jrwb.de/chents/coverage/coverage.html)
-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.
+```{r, results = "asis", echo = FALSE}
+read.dcf("DESCRIPTION")[, "Description"] |> cat()
+```
+## Usage
When first defining a chemical entity, some chemical information
is retrieved from the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) website using

Contact - Imprint