aboutsummaryrefslogtreecommitdiff
path: root/man/endpoints.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-10-25 00:37:42 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:03:54 +0200
commit0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (patch)
tree1bf0ffeb710b3438fee224d0a657606b4c36b495 /man/endpoints.Rd
parent053bf27d3f265c7a7378e2df3e00cf891e0d1bb2 (diff)
Use roxygen for functions and methods
Diffstat (limited to 'man/endpoints.Rd')
-rw-r--r--man/endpoints.Rd38
1 files changed, 20 insertions, 18 deletions
diff --git a/man/endpoints.Rd b/man/endpoints.Rd
index 55a4cb0a..13182369 100644
--- a/man/endpoints.Rd
+++ b/man/endpoints.Rd
@@ -1,33 +1,35 @@
+% 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
-}
-\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 constantes of the DFOP model, but
-with the advantage that the SFORB model can also be used for metabolites.
-}
+\title{Function to calculate endpoints for further use from kinetic models fitted
+with mkinfit}
\usage{
endpoints(fit)
}
\arguments{
- \item{fit}{
- An object of class \code{\link{mkinfit}}.
- }
-}
-\note{
- The function is used internally by \code{\link{summary.mkinfit}}.
+\item{fit}{An object of class \code{\link{mkinfit}}.}
}
\value{
- A list with the components mentioned above.
+A list with the components mentioned above.
+}
+\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 constantes of the DFOP model, but with the
+advantage that the SFORB model can also be used for metabolites.
+}
+\note{
+The function is used internally by \code{\link{summary.mkinfit}}.
}
\examples{
+
fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
endpoints(fit)
+
}
\author{
- Johannes Ranke
+Johannes Ranke
}
-\keyword{ manip }
+\keyword{manip}

Contact - Imprint