From e0c130005ee7adbac9b832ea8157712419d51b7e Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Mon, 22 Jun 2026 18:01:11 +0200 Subject: Update static docs --- docs/reference/plot.one_box.md | 83 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 docs/reference/plot.one_box.md (limited to 'docs/reference/plot.one_box.md') diff --git a/docs/reference/plot.one_box.md b/docs/reference/plot.one_box.md new file mode 100644 index 0000000..cc20b94 --- /dev/null +++ b/docs/reference/plot.one_box.md @@ -0,0 +1,83 @@ +# Plot time series of decline data + +Plot time series of decline data + +## Usage + +``` r +# S3 method for class 'one_box' +plot( + x, + xlim = range(time(x)), + ylim = c(0, max(x)), + xlab = "Time", + ylab = "Residue", + max_twa = NULL, + max_twa_var = dimnames(x)[[2]][1], + ... +) +``` + +## Arguments + +- x: + + The object of type + [one_box](https://pkgdown.jrwb.de/pfm/reference/one_box.md) to be + plotted + +- xlim: + + Limits for the x axis + +- ylim: + + Limits for the y axis + +- xlab: + + Label for the x axis + +- ylab: + + Label for the y axis + +- max_twa: + + If a numeric value is given, the maximum time weighted average + concentration(s) is/are shown in the graph. + +- max_twa_var: + + Variable for which the maximum time weighted average should be shown + if max_twa is not NULL. + +- ...: + + Further arguments passed to methods + +## See also + +[sawtooth](https://pkgdown.jrwb.de/pfm/reference/sawtooth.md) + +## Examples + +``` r +dfop_pred <- one_box("DFOP", parms = c(k1 = 0.2, k2 = 0.02, g = 0.7)) +plot(dfop_pred) + +plot(sawtooth(dfop_pred, 3, 7), max_twa = 21) + + + +# Use a fitted mkinfit model +m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO")) +#> Temporary DLL for differentials generated and loaded +fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE) +#> Warning: Observations with value of zero were removed from the data +pred_2 <- one_box(fit_2, ini = 1) +pred_2_saw <- sawtooth(pred_2, 2, 7) +plot(pred_2_saw) +plot(pred_2_saw, max_twa = 21, max_twa_var = "m1") + +``` -- cgit v1.2.3