aboutsummaryrefslogtreecommitdiff
path: root/man/parms.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/parms.Rd')
-rw-r--r--man/parms.Rd40
1 files changed, 25 insertions, 15 deletions
diff --git a/man/parms.Rd b/man/parms.Rd
index af92bd2a..5c0e8895 100644
--- a/man/parms.Rd
+++ b/man/parms.Rd
@@ -1,36 +1,43 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/parms.mkinfit.R
+% Please edit documentation in R/parms.R
\name{parms}
\alias{parms}
\alias{parms.mkinfit}
\alias{parms.mmkin}
-\title{Extract model parameters from mkinfit models}
+\alias{parms.multistart}
+\title{Extract model parameters}
\usage{
parms(object, ...)
-\method{parms}{mkinfit}(object, transformed = FALSE, ...)
+\method{parms}{mkinfit}(object, transformed = FALSE, errparms = TRUE, ...)
-\method{parms}{mmkin}(object, transformed = FALSE, ...)
+\method{parms}{mmkin}(object, transformed = FALSE, errparms = TRUE, ...)
+
+\method{parms}{multistart}(object, exclude_failed = TRUE, ...)
}
\arguments{
-\item{object}{A fitted model object. Methods are implemented for
-\code{\link[=mkinfit]{mkinfit()}} objects and for \code{\link[=mmkin]{mmkin()}} objects.}
+\item{object}{A fitted model object.}
\item{\dots}{Not used}
-\item{transformed}{Should the parameters be returned
-as used internally during the optimisation?}
+\item{transformed}{Should the parameters be returned as used internally
+during the optimisation?}
+
+\item{errparms}{Should the error model parameters be returned
+in addition to the degradation parameters?}
+
+\item{exclude_failed}{For \link{multistart} objects, should rows for failed fits
+be removed from the returned parameter matrix?}
}
\value{
-For mkinfit objects, a numeric vector of fitted model parameters.
-For mmkin row objects, a matrix with the parameters with a
-row for each dataset. If the mmkin object has more than one row, a list of
-such matrices is returned.
+Depending on the object, a numeric vector of fitted model parameters,
+a matrix (e.g. for mmkin row objects), or a list of matrices (e.g. for
+mmkin objects with more than one row).
}
\description{
-This function always returns degradation model parameters as well as error
-model parameters, in order to avoid working with a fitted model without
-considering the error structure that was assumed for the fit.
+This function returns degradation model parameters as well as error
+model parameters per default, in order to avoid working with a fitted model
+without considering the error structure that was assumed for the fit.
}
\examples{
# mkinfit objects
@@ -50,3 +57,6 @@ parms(fits)
parms(fits, transformed = TRUE)
}
}
+\seealso{
+\link{saem}, \link{multistart}
+}

Contact - Imprint