Summary method for mmkin objects

Also, add a method for gathering convergence information
and a method for gathering information on ill-defined parameters

4 files changed, 122 insertions, 1 deletions

diff --git a/man/convergence.Rd b/man/convergence.Rd
new file mode 100644
index 00000000..635eb9ae
--- /dev/null
+++ b/man/convergence.Rd
@@ -0,0 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/convergence.R
+\name{convergence}
+\alias{convergence}
+\alias{convergence.mmkin}
+\alias{print.convergence.mmkin}
+\title{Method to get convergence information}
+\usage{
+convergence(object, ...)
+
+\method{convergence}{mmkin}(object, ...)
+
+\method{print}{convergence.mmkin}(x, ...)
+}
+\arguments{
+\item{object}{The object to investigate}
+
+\item{\dots}{For potential future extensions}
+
+\item{x}{The object to be printed}
+}
+\value{
+For \link{mkinfit} objects, a character vector containing
+For \link{mmkin} objects, an object of class 'convergence.mmkin' with a
+suitable printing method.
+}
+\description{
+Method to get convergence information
+}
+\examples{
+\dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS B" = FOCUS_2006_C),
+  quiet = TRUE)
+convergence(fits)
+}
+}
diff --git a/man/illparms.Rd b/man/illparms.Rd
new file mode 100644
index 00000000..7f70229d
--- /dev/null
+++ b/man/illparms.Rd
@@ -0,0 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/illparms.R
+\name{illparms}
+\alias{illparms}
+\alias{illparms.mkinfit}
+\alias{illparms.mmkin}
+\alias{print.illparms.mmkin}
+\title{Method to get the names of ill-defined parameters}
+\usage{
+illparms(object, ...)
+
+\method{illparms}{mkinfit}(object, conf.level = 0.95, ...)
+
+\method{illparms}{mmkin}(object, conf.level = 0.95, ...)
+
+\method{print}{illparms.mmkin}(x, ...)
+}
+\arguments{
+\item{object}{The object to investigate}
+
+\item{\dots}{For potential future extensions}
+
+\item{conf.level}{The confidence level for checking p values}
+
+\item{x}{The object to be printed}
+}
+\value{
+For \link{mkinfit} objects, a character vector of parameter names
+For \link{mmkin} objects, an object of class 'illparms.mmkin' with a
+suitable printing method.
+}
+\description{
+Method to get the names of ill-defined parameters
+}
+\examples{
+fit <- mkinfit("FOMC", FOCUS_2006_A, quiet = TRUE)
+illparms(fit)
+\dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS C" = FOCUS_2006_C),
+  quiet = TRUE)
+illparms(fits)
+}
+}
diff --git a/man/summary.mkinfit.Rd b/man/summary.mkinfit.Rd
index 24991d71..b6c1fb87 100644
--- a/man/summary.mkinfit.Rd
+++ b/man/summary.mkinfit.Rd
@@ -60,7 +60,7 @@ values.
 }
 \examples{
 
-  summary(mkinfit(mkinmod(parent = mkinsub("SFO")), FOCUS_2006_A, quiet = TRUE))
+  summary(mkinfit("SFO", FOCUS_2006_A, quiet = TRUE))
 
 }
 \references{
diff --git a/man/summary.mmkin.Rd b/man/summary.mmkin.Rd
new file mode 100644
index 00000000..69245621
--- /dev/null
+++ b/man/summary.mmkin.Rd
@@ -0,0 +1,36 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/summary.mmkin.R
+\name{summary.mmkin}
+\alias{summary.mmkin}
+\alias{print.summary.mmkin}
+\title{Summary method for class "mmkin"}
+\usage{
+\method{summary}{mmkin}(object, conf.level = 0.95, ...)
+
+\method{print}{summary.mmkin}(x, digits = max(3, getOption("digits") - 3), ...)
+}
+\arguments{
+\item{object}{an object of class \link{mmkin}}
+
+\item{conf.level}{confidence level for testing parameters}
+
+\item{\dots}{optional arguments passed to methods like \code{print}.}
+
+\item{x}{an object of class \code{summary.mmkin}.}
+
+\item{digits}{number of digits to use for printing}
+}
+\description{
+Shows convergence information on the \link{mkinfit} objects contained in the object
+and gives an overview of ill-defined parameters calculated by \link{illparms}.
+}
+\examples{
+
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS C" = FOCUS_2006_C),
+  quiet = TRUE, cores = 1)
+  summary(fits)
+
+}