aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2022-09-28 16:34:57 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2022-09-28 16:34:57 +0200
commit3529f5ff498d7d054c7b1911ddfc4b242902b85d (patch)
tree4c642bfddcc68e353fe75e8037d39ad8f269d56e /man
parent75f361bed527b91bec205c5452add13247760d61 (diff)
Fix handling of multistart fits with failures
Diffstat (limited to 'man')
-rw-r--r--man/multistart.Rd3
-rw-r--r--man/parms.Rd8
2 files changed, 7 insertions, 4 deletions
diff --git a/man/multistart.Rd b/man/multistart.Rd
index aa352267..78ff4614 100644
--- a/man/multistart.Rd
+++ b/man/multistart.Rd
@@ -4,7 +4,6 @@
\alias{multistart}
\alias{multistart.saem.mmkin}
\alias{print.multistart}
-\alias{parms.multistart}
\title{Perform a hierarchical model fit with multiple starting values}
\usage{
multistart(
@@ -18,8 +17,6 @@ multistart(
\method{multistart}{saem.mmkin}(object, n = 50, cores = 1, cluster = NULL, ...)
\method{print}{multistart}(x, ...)
-
-\method{parms}{multistart}(object, ...)
}
\arguments{
\item{object}{The fit object to work with}
diff --git a/man/parms.Rd b/man/parms.Rd
index acae2d91..5c0e8895 100644
--- a/man/parms.Rd
+++ b/man/parms.Rd
@@ -1,9 +1,10 @@
% 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}
+\alias{parms.multistart}
\title{Extract model parameters}
\usage{
parms(object, ...)
@@ -11,6 +12,8 @@ parms(object, ...)
\method{parms}{mkinfit}(object, transformed = FALSE, errparms = TRUE, ...)
\method{parms}{mmkin}(object, transformed = FALSE, errparms = TRUE, ...)
+
+\method{parms}{multistart}(object, exclude_failed = TRUE, ...)
}
\arguments{
\item{object}{A fitted model object.}
@@ -22,6 +25,9 @@ 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{
Depending on the object, a numeric vector of fitted model parameters,

Contact - Imprint