From aed160d7f0eaf5865e2bd9bf6c4b1c9d7b13d911 Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Wed, 31 Jan 2024 13:16:17 +0100 Subject: Reorganise data generation - Use inst/data_generation for R code generating data as in some of my other packages - data/*.RData files were checked using https://github.com/jranke/dotfiles/blob/main/bin/rda_diff contents were not changed - Remove ChangeLog, the history is in the git logs - Update docs and some links contained therein - use \doi{} markup - Move logs to log directory --- docs/reference/pfm_degradation.html | 210 +++++++++++++----------------------- 1 file changed, 72 insertions(+), 138 deletions(-) (limited to 'docs/reference/pfm_degradation.html') diff --git a/docs/reference/pfm_degradation.html b/docs/reference/pfm_degradation.html index 8d06107..724a1aa 100644 --- a/docs/reference/pfm_degradation.html +++ b/docs/reference/pfm_degradation.html @@ -1,67 +1,12 @@ - - - - - - - -Calculate a time course of relative concentrations based on an mkinmod model — pfm_degradation • pfm - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Calculate a time course of relative concentrations based on an mkinmod model — pfm_degradation • pfm - - - - + + -
-
- -
- -
+

Calculate a time course of relative concentrations based on an mkinmod model

@@ -112,80 +43,83 @@

Calculate a time course of relative concentrations based on an mkinmod model

- 
pfm_degradation(
-  model = "SFO",
-  DT50 = 1000,
-  parms = c(k_parent = log(2)/DT50),
-  years = 1,
-  step_days = 1,
-  times = seq(0, years * 365, by = step_days)
-)
- -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - -
model

The degradation model to be used. Either a parent only model like -'SFO' or 'FOMC', or an mkinmod object

DT50

The half-life. This is only used when simple exponential decline -is calculated (SFO model).

parms

The parameters used for the degradation model

years

For how many years should the degradation be predicted?

step_days

What step size in days should the output have?

times

The output times

- - -

Examples

- 
head(pfm_degradation("SFO", DT50 = 10))
#>   time    parent
-#> 0    0 1.0000000
-#> 1    1 0.9330330
-#> 2    2 0.8705506
-#> 3    3 0.8122524
-#> 4    4 0.7578583
-#> 5    5 0.7071068
+
+ 
pfm_degradation(
+  model = "SFO",
+  DT50 = 1000,
+  parms = c(k_parent = log(2)/DT50),
+  years = 1,
+  step_days = 1,
+  times = seq(0, years * 365, by = step_days)
+)
+
+ +
+

Arguments

+
model
+

The degradation model to be used. Either a parent only model like +'SFO' or 'FOMC', or an mkinmod object

+ + +
DT50
+

The half-life. This is only used when simple exponential decline +is calculated (SFO model).

+ + +
parms
+

The parameters used for the degradation model

+ + +
years
+

For how many years should the degradation be predicted?

+ + +
step_days
+

What step size in days should the output have?

+ + +
times
+

The output times

+ +
+
+

Author

+

Johannes Ranke

+
+ +
+

Examples

+ 
head(pfm_degradation("SFO", DT50 = 10))
+#>   time    parent
+#> 0    0 1.0000000
+#> 1    1 0.9330330
+#> 2    2 0.8705506
+#> 3    3 0.8122524
+#> 4    4 0.7578583
+#> 5    5 0.7071068
+
+
+
-
- - + + -- cgit v1.2.1