From b3ca0aa552916b10a7d6d642138aecf744aed3de Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 28 Feb 2022 15:05:58 +0100 Subject: Update docs --- docs/dev/reference/endpoints.html | 225 ++++++++++++++------------------------ 1 file changed, 82 insertions(+), 143 deletions(-) (limited to 'docs/dev/reference/endpoints.html') diff --git a/docs/dev/reference/endpoints.html b/docs/dev/reference/endpoints.html index aa5bd773..a472b054 100644 --- a/docs/dev/reference/endpoints.html +++ b/docs/dev/reference/endpoints.html @@ -1,73 +1,18 @@ - - - - - - - -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 — endpoints • mkin - - - - - - - - - - + + - - - -
-
- -
- -
+

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

- Source: R/endpoints.R + Source: R/endpoints.R
@@ -158,93 +94,96 @@ 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)
+
+ 
endpoints(fit)
+
-

Arguments

- - - - - - -
fit

An object of class mkinfit, nlme.mmkin, saem.mmkin or -nlmixr.mmkin. Or another object that has list components -mkinmod containing an mkinmod degradation model, and two numeric vectors, +

+

Arguments

+
fit
+

An object of class mkinfit, nlme.mmkin, saem.mmkin or +nlmixr.mmkin. Or another object that has list components +mkinmod containing an mkinmod degradation model, and two numeric vectors, bparms.optim and bparms.fixed, that contain parameter values -for that model.

- -

Value

- +for that model.

+
+
+

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

-

Details

- +
+
+

Details

Additional DT50 values are calculated from the FOMC DT90 and k1 and k2 from HS and DFOP, as well as from Eigenvalues b1 and b2 of any SFORB models

-

Note

- -

The function is used internally by summary.mkinfit, -summary.nlme.mmkin and summary.saem.mmkin.

-

Author

- +
+
+

Note

+

The function is used internally by summary.mkinfit, +summary.nlme.mmkin and summary.saem.mmkin.

+
+
+

Author

Johannes Ranke

+
-

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("DFOP", FOCUS_2006_C, quiet = TRUE)
-    endpoints(fit_2)
-
#> $distimes
-#>            DT50     DT90 DT50back  DT50_k1  DT50_k2
-#> parent 1.886925 21.25106 6.397207 1.508293 38.83438
-#> 
    fit_3 <- mkinfit("SFORB", FOCUS_2006_C, quiet = TRUE)
-    endpoints(fit_3)
-
#> $ff
-#> parent_free 
-#>           1 
-#> 
-#> $SFORB
-#> parent_b1 parent_b2 
-#> 0.4595574 0.0178488 
-#> 
-#> $distimes
-#>            DT50     DT90 DT50back DT50_parent_b1 DT50_parent_b2
-#> parent 1.886925 21.25106 6.397208       1.508293       38.83438
-#> 
  # }
-
-
+
+

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("DFOP", FOCUS_2006_C, quiet = TRUE)
+    endpoints(fit_2)
+#> $distimes
+#>            DT50     DT90 DT50back  DT50_k1  DT50_k2
+#> parent 1.886925 21.25106 6.397207 1.508293 38.83438
+#> 
+    fit_3 <- mkinfit("SFORB", FOCUS_2006_C, quiet = TRUE)
+    endpoints(fit_3)
+#> $ff
+#> parent_free 
+#>           1 
+#> 
+#> $SFORB
+#> parent_b1 parent_b2 
+#> 0.4595574 0.0178488 
+#> 
+#> $distimes
+#>            DT50     DT90 DT50back DT50_parent_b1 DT50_parent_b2
+#> parent 1.886925 21.25106 6.397208       1.508293       38.83438
+#> 
+  # }
+
+
+
+
- - - + + -- cgit v1.2.1