summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index 59217fe..ac78192 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
# pfm
+[![Online documentation](https://img.shields.io/badge/docs-jrwb.de-blue.svg)](https://pkgdown.jrwb.de/pfm/)
[![pfm status badge](https://jranke.r-universe.dev/badges/pfm)](https://jranke.r-universe.dev/ui/#package:pfm)
[![Build Status](https://app.travis-ci.com/jranke/pfm.svg?token=Sq9VuYWyRz2FbBLxu6DK&branch=main)](https://app.travis-ci.com/jranke/pfm)
[![codecov](https://codecov.io/github/jranke/pfm/branch/main/graphs/badge.svg)](https://codecov.io/github/jranke/pfm)
The R package **pfm** provides some utilities for fate modelling, including
-dealing with FOCUS pesticide fate modelling tools, (currently only TOXSWA cwa
+simple PEC calculation routines and some routines for
+dealing with FOCUS pesticide fate modelling tools (currently only TOXSWA cwa
and out files), made available under the GNU public license.
## Installation
@@ -14,15 +16,17 @@ The easiest way to install the package is probably to use the
[r-universe repo](https://jranke.r-universe.dev/pfm):
```r
-install.packages("pfm", repos = c("https://jranke.r-universe.dev", "https://cran.r-project.org"))
+install.packages("pfm",
+ repos = c("https://jranke.r-universe.dev", "https://cran.r-project.org"))
```
-Alternatively you can install the package
-using the `remotes` package. Using `quick = TRUE` skips docs,
-multiple-architecture builds, demos, and vignettes.
+The packages at R-universe are provided with a slight delay. Alternatively, you
+can install the package directly from github, e.g. by using
+[`pak`](https://pak.r-lib.org).
```r
-remotes::install_github("jranke/pfm", quick = TRUE)
+# install.packages("pak")
+pak::pak("jranke/pfm")
```
## Use
@@ -31,7 +35,7 @@ Please refer to the [reference](http://pkgdown.jrwb.de/pfm/reference/index.html)
## Examples
-One recent nice example of the usage of this package is the visualisation
+One nice example of the usage of this package is the visualisation
of a time weighted average for a sawtooth curve obtained from several overlays
of mkinfit predictions as shown [here](http://pkgdown.jrwb.de/pfm/reference/plot.one_box.html).

Contact - Imprint