aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/multistart.Rd10
-rw-r--r--man/parms.Rd21
2 files changed, 16 insertions, 15 deletions
diff --git a/man/multistart.Rd b/man/multistart.Rd
index 4dd95503..cb971557 100644
--- a/man/multistart.Rd
+++ b/man/multistart.Rd
@@ -17,9 +17,9 @@ multistart(object, n = 50, cores = 1, ...)
\method{parms}{multistart}(object, ...)
-parhist(object, lpos = "topleft", ...)
+parhist(object, lpos = "topleft", main = "", ...)
-llhist(object, breaks = "Sturges", main = "", lpos = "topleft", ...)
+llhist(object, breaks = "Sturges", lpos = "topleft", main = "", ...)
}
\arguments{
\item{object}{The fit object to work with}
@@ -30,15 +30,15 @@ used?}
\item{cores}{How many fits should be run in parallel?}
\item{\dots}{Passed to the update function, or to the basic plotting
-function in the case of the graphical function.}
+function in the case of the graphical functions.}
\item{x}{The multistart object to print}
\item{lpos}{Positioning of the legend.}
-\item{breaks}{Passed to \link{hist}}
-
\item{main}{title of the plot}
+
+\item{breaks}{Passed to \link{hist}}
}
\value{
A list of \link{saem.mmkin} objects, with class attributes
diff --git a/man/parms.Rd b/man/parms.Rd
index 293bdaab..acae2d91 100644
--- a/man/parms.Rd
+++ b/man/parms.Rd
@@ -4,7 +4,7 @@
\alias{parms}
\alias{parms.mkinfit}
\alias{parms.mmkin}
-\title{Extract model parameters from mkinfit models}
+\title{Extract model parameters}
\usage{
parms(object, ...)
@@ -13,8 +13,7 @@ parms(object, ...)
\method{parms}{mmkin}(object, transformed = FALSE, errparms = 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}
@@ -25,15 +24,14 @@ during the optimisation?}
in addition to the degradation parameters?}
}
\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
@@ -53,3 +51,6 @@ parms(fits)
parms(fits, transformed = TRUE)
}
}
+\seealso{
+\link{saem}, \link{multistart}
+}

Contact - Imprint