aboutsummaryrefslogtreecommitdiff
path: root/man/parms.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/parms.Rd')
-rw-r--r--man/parms.Rd13
1 files changed, 12 insertions, 1 deletions
diff --git a/man/parms.Rd b/man/parms.Rd
index 5c0e8895..b1551374 100644
--- a/man/parms.Rd
+++ b/man/parms.Rd
@@ -1,10 +1,11 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/parms.R
+% Please edit documentation in R/parms.R, R/saem.R
\name{parms}
\alias{parms}
\alias{parms.mkinfit}
\alias{parms.mmkin}
\alias{parms.multistart}
+\alias{parms.saem.mmkin}
\title{Extract model parameters}
\usage{
parms(object, ...)
@@ -14,6 +15,8 @@ parms(object, ...)
\method{parms}{mmkin}(object, transformed = FALSE, errparms = TRUE, ...)
\method{parms}{multistart}(object, exclude_failed = TRUE, ...)
+
+\method{parms}{saem.mmkin}(object, ci = FALSE, covariates = NULL, ...)
}
\arguments{
\item{object}{A fitted model object.}
@@ -28,6 +31,14 @@ 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?}
+
+\item{ci}{Should a matrix with estimates and confidence interval boundaries
+be returned? If FALSE (default), a vector of estimates is returned if no
+covariates are given, otherwise a matrix of estimates is returned, with
+each column corresponding to a row of the data frame holding the covariates}
+
+\item{covariates}{A data frame holding covariate values for which to
+return parameter values. Only has an effect if 'ci' is FALSE.}
}
\value{
Depending on the object, a numeric vector of fitted model parameters,

Contact - Imprint