diff options
| author | Johannes Ranke <johannes.ranke@jrwb.de> | 2026-07-03 11:51:32 +0200 |
|---|---|---|
| committer | Johannes Ranke <johannes.ranke@jrwb.de> | 2026-07-03 11:51:32 +0200 |
| commit | 88027b7a70510b48bd7525ffcd536f0808d263e7 (patch) | |
| tree | 94f83bd420d494334011ff8f67a27483130fe857 /docs/reference/pai.md | |
| parent | 32caaedcc6b6b8addc9f23fce9dca4188f692fed (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 'docs/reference/pai.md')
| -rw-r--r-- | docs/reference/pai.md | 41 |
1 files changed, 20 insertions, 21 deletions
diff --git a/docs/reference/pai.md b/docs/reference/pai.md index 2291653..b957cb2 100644 --- a/docs/reference/pai.md +++ b/docs/reference/pai.md @@ -16,8 +16,7 @@ object ## Super class -[`chents::chent`](https://pkgdown.jrwb.de/chents/reference/chent.md) -\> -`pai` +[`chent`](https://pkgdown.jrwb.de/chents/reference/chent.md) -\> `pai` ## Public fields @@ -34,31 +33,31 @@ object ### Public methods -- [`pai$new()`](#method-pai-new) +- [`pai$new()`](#method-pai-initialize) - [`pai$clone()`](#method-pai-clone) Inherited methods -- [`chents::chent$add_PUF()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_PUF) -- [`chents::chent$add_TP()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_TP) -- [`chents::chent$add_cwsat()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_cwsat) -- [`chents::chent$add_p0()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_p0) -- [`chents::chent$add_soil_degradation()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_soil_degradation) -- [`chents::chent$add_soil_ff()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_soil_ff) -- [`chents::chent$add_soil_sorption()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_soil_sorption) -- [`chents::chent$add_transformation()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_transformation) -- [`chents::chent$emf()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-emf) -- [`chents::chent$get_chyaml()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-get_chyaml) -- [`chents::chent$get_pubchem()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-get_pubchem) -- [`chents::chent$get_rdkit()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-get_rdkit) -- [`chents::chent$pdf()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-pdf) -- [`chents::chent$png()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-png) -- [`chents::chent$try_pubchem()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-try_pubchem) +- [`chent$add_PUF()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_PUF) +- [`chent$add_TP()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_TP) +- [`chent$add_cwsat()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_cwsat) +- [`chent$add_p0()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_p0) +- [`chent$add_soil_degradation()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_soil_degradation) +- [`chent$add_soil_ff()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_soil_ff) +- [`chent$add_soil_sorption()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_soil_sorption) +- [`chent$add_transformation()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-add_transformation) +- [`chent$emf()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-emf) +- [`chent$get_chyaml()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-get_chyaml) +- [`chent$get_pubchem()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-get_pubchem) +- [`chent$get_rdkit()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-get_rdkit) +- [`chent$pdf()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-pdf) +- [`chent$png()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-png) +- [`chent$try_pubchem()`](https://pkgdown.jrwb.de/chents/reference/chent.html#method-try_pubchem) ------------------------------------------------------------------------ -### Method `new()` +### `pai$new()` Create a new pai object @@ -123,7 +122,7 @@ Create a new pai object ------------------------------------------------------------------------ -### Method `clone()` +### `pai$clone()` The objects of this class are cloneable with this method. @@ -180,7 +179,7 @@ print(decanol) #> "CCCCCCCCCCO" #> Molecular weight $mw: 158.3 #> PubChem synonyms (up to 10): -#> [1] "1-DECANOL" "Decan-1-ol" "Decyl alcohol" "112-30-1" +#> [1] "1-DECANOL" "Decyl alcohol" "Decan-1-ol" "112-30-1" #> [5] "n-Decyl alcohol" "n-Decanol" "Capric alcohol" "Nonylcarbinol" #> [9] "Antak" "Royaltac" # } |