aboutsummaryrefslogtreecommitdiff
path: root/man/endpoints.Rd
blob: a37ff98d19b0c3d7d234df72b19e034623cf5755 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/endpoints.R
\name{endpoints}
\alias{endpoints}
\title{Function to calculate endpoints for further use from kinetic models fitted
with mkinfit}
\usage{
endpoints(fit)
}
\arguments{
\item{fit}{An object of class \link{mkinfit}, \link{nlme.mmkin}, \link{saem.mmkin} or
\link{nlmixr.mmkin}. Or another object that has list components
mkinmod containing an \link{mkinmod} degradation model, and two numeric vectors,
bparms.optim and bparms.fixed, that contain parameter values
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
}
\description{
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.
}
\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 \link{summary.mkinfit},
\link{summary.nlme.mmkin} and \link{summary.saem.mmkin}.
}
\examples{

  fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
  endpoints(fit)
  \dontrun{
    fit_2 <- mkinfit("DFOP", FOCUS_2006_C, quiet = TRUE)
    endpoints(fit_2)
    fit_3 <- mkinfit("SFORB", FOCUS_2006_C, quiet = TRUE)
    endpoints(fit_3)
  }

}
\author{
Johannes Ranke
}

Contact - Imprint