From 8b7edd4eaf0d196e674a085f744d1a69260a6c91 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 16 Nov 2023 06:02:05 +0100 Subject: Update pkgdown docs to bootstrap 5 with search --- docs/reference/endpoints.html | 206 ++++++++++++++++++------------------------ 1 file changed, 86 insertions(+), 120 deletions(-) (limited to 'docs/reference/endpoints.html') diff --git a/docs/reference/endpoints.html b/docs/reference/endpoints.html index 4ce6a8ca..c6e216d9 100644 --- a/docs/reference/endpoints.html +++ b/docs/reference/endpoints.html @@ -1,6 +1,10 @@ -Function to calculate endpoints for further use from kinetic models fitted -with mkinfit — endpoints • mkinFunction to calculate endpoints for further use from kinetic models fitted +with mkinfit — endpoints • mkin + + Skip to contents -
-
-
-
-

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

+
+
+
+

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

- Source: R/endpoints.R - + Source: R/endpoints.R +
endpoints.Rd
-
+

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 @@ -123,12 +92,13 @@ are equivalent to the rate constants of the DFOP model, but with the advantage that the SFORB model can also be used for metabolites.

-
+
+

Usage

endpoints(fit, covariates = NULL, covariate_quantile = 0.5)
-
-

Arguments

+
+

Arguments

fit

An object of class mkinfit, nlme.mmkin or saem.mmkin, or another object that has list components mkinmod containing an mkinmod @@ -147,8 +117,8 @@ object has covariate models. If so, the default is to show endpoints for the median of the covariate values (50th percentile).

-
-

Value

+
+

Value

A list with a matrix of dissipation times named distimes, and, if @@ -156,23 +126,23 @@ 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

+
+

Note

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

-
-

Author

+
+

Author

Johannes Ranke

-
-

Examples

+
+

Examples


   fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
   endpoints(fit)
@@ -205,26 +175,22 @@ HS and DFOP, as well as from Eigenvalues b1 and b2 of any SFORB models
-
- -
+
-
- -- cgit v1.2.1