Fix handling of multistart fits with failures

1 files changed, 7 insertions, 1 deletions

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,