aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: af2bcd393c642cb95a5c296e6466c119cecd2b30 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# pfm

[![pfm status badge](https://jranke.r-universe.dev/badges/pfm)](https://jranke.r-universe.dev/ui/#package: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
and out files), made available under the GNU public license.

## Installation

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"))
```

Alternatively you can install the package 
using the `remotes` package.  Using `quick = TRUE` skips docs,
multiple-architecture builds, demos, and vignettes.

```r
remotes::install_github("jranke/pfm", quick = TRUE)
```

## Use

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
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