From a77a10ea6c607346778ba0700b3b66ac393101a2 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 27 May 2020 06:06:08 +0200 Subject: Create up to date pkgdown docs in development mode --- docs/dev/reference/endpoints.html | 232 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 232 insertions(+) create mode 100644 docs/dev/reference/endpoints.html (limited to 'docs/dev/reference/endpoints.html') diff --git a/docs/dev/reference/endpoints.html b/docs/dev/reference/endpoints.html new file mode 100644 index 00000000..5751df93 --- /dev/null +++ b/docs/dev/reference/endpoints.html @@ -0,0 +1,232 @@ + + + + + + + + +Function to calculate endpoints for further use from kinetic models fitted +with mkinfit — endpoints • mkin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

Function to calculate endpoints for further use from kinetic models fitted +with mkinfit

+ Source: R/endpoints.R + +
+ +
+

This function calculates DT50 and DT90 values as well as formation fractions +from kinetic models fitted with mkinfit. If the SFORB model was specified +for one of the parents or metabolites, the Eigenvalues are returned. These +are equivalent to the rate constants of the DFOP model, but with the +advantage that the SFORB model can also be used for metabolites.

+
+ + 
endpoints(fit)
+ +

Arguments

+ + + + + + +
fit

An object of class mkinfit or +nlme.mmkin

+ +

Value

+ +

A list with a matrix of dissipation times named distimes, +and, if applicable, a vector of formation fractions named ff +and, if the SFORB model was in use, a vector of eigenvalues +of these SFORB models, equivalent to DFOP rate constants

+

Note

+ +

The function is used internally by summary.mkinfit.

+ +

Examples

+ 

+  fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
+  endpoints(fit)
#> $distimes
+#>            DT50    DT90 DT50back
+#> parent 1.785233 15.1479 4.559973
+#> 
  # \dontrun{
+    fit_2 <- mkinfit("SFORB", FOCUS_2006_C, quiet = TRUE)
+    endpoints(fit_2)
#> $ff
+#> parent_free_sink 
+#>                1 
+#> 
+#> $SFORB
+#> parent_b1 parent_b2 
+#> 0.4595574 0.0178488 
+#> 
+#> $distimes
+#>            DT50     DT90 DT50_parent_b1 DT50_parent_b2
+#> parent 1.886925 21.25106       1.508293       38.83438
+#> 
  # }
+
+
+
+ +
+ + + +
+ + + + + + + + -- cgit v1.2.1