From 2a521ab0a4b7d981a2042353e2c60b8a877489b8 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 16 Sep 2022 10:51:48 +0200 Subject: Improve docs and update pkgdown --- man/parms.Rd | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'man/parms.Rd') 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} +} -- cgit v1.2.1