aboutsummaryrefslogtreecommitdiff
path: root/man/AIC.mmkin.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/AIC.mmkin.Rd
parent053bf27d3f265c7a7378e2df3e00cf891e0d1bb2 (diff)
Use roxygen for functions and methods
Diffstat (limited to 'man/AIC.mmkin.Rd')
-rw-r--r--man/AIC.mmkin.Rd39
1 files changed, 19 insertions, 20 deletions
diff --git a/man/AIC.mmkin.Rd b/man/AIC.mmkin.Rd
index ca3fcf20..42c9a73b 100644
--- a/man/AIC.mmkin.Rd
+++ b/man/AIC.mmkin.Rd
@@ -1,31 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/AIC.mmkin.R
\name{AIC.mmkin}
\alias{AIC.mmkin}
-\title{
- Calculated the AIC for a column of an mmkin object
-}
-\description{
- Provides a convenient way to compare different kineti models fitted to the
- same dataset.
-}
+\title{Calculated the AIC for a column of an mmkin object}
\usage{
- \method{AIC}{mmkin}(object, ..., k = 2)
+\method{AIC}{mmkin}(object, ..., k = 2)
}
\arguments{
- \item{object}{
- An object of class \code{\link{mmkin}}, containing only one column.
- }
- \item{\dots}{
- For compatibility with the generic method
- }
- \item{k}{
- As in the generic method
- }
+\item{object}{An object of class \code{\link{mmkin}}, containing only one
+column.}
+
+\item{\dots}{For compatibility with the generic method}
+
+\item{k}{As in the generic method}
}
\value{
- As in the generic method (a numeric value for single fits, or a dataframe if
- there are several fits in the column).
+As in the generic method (a numeric value for single fits, or a
+ dataframe if there are several fits in the column).
+}
+\description{
+Provides a convenient way to compare different kinetic models fitted to the
+same dataset.
}
\examples{
+
\dontrun{ # skip, as it takes > 10 s on winbuilder
f <- mmkin(c("SFO", "FOMC", "DFOP"),
list("FOCUS A" = FOCUS_2006_A,
@@ -40,7 +38,8 @@
# For FOCUS C, the more complex models fit better
AIC(f[, "FOCUS C"])
}
+
}
\author{
- Johannes Ranke
+Johannes Ranke
}

Contact - Imprint