From 4c868d65be04c8ee3fedc89d28d0e7d8c5da05e0 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Fri, 28 Oct 2022 10:31:16 +0200
Subject: Rename 'convergence' method to 'status'

The reason is that it is misleading in the case of saem.mmkin objects,
because convergence is not really checked there.
---
 man/convergence.Rd   | 39 ---------------------------------------
 man/status.Rd        | 38 ++++++++++++++++++++++++++++++++++++++
 man/summary.mmkin.Rd |  2 +-
 3 files changed, 39 insertions(+), 40 deletions(-)
 delete mode 100644 man/convergence.Rd
 create mode 100644 man/status.Rd

(limited to 'man')

diff --git a/man/convergence.Rd b/man/convergence.Rd
deleted file mode 100644
index 635eb9ae..00000000
--- a/man/convergence.Rd
+++ /dev/null
@@ -1,39 +0,0 @@
-% 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/status.Rd b/man/status.Rd
new file mode 100644
index 00000000..8ff3531b
--- /dev/null
+++ b/man/status.Rd
@@ -0,0 +1,38 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/status.R
+\name{status}
+\alias{status}
+\alias{status.mmkin}
+\alias{print.status.mmkin}
+\title{Method to get status information for fit array objects}
+\usage{
+status(object, ...)
+
+\method{status}{mmkin}(object, ...)
+
+\method{print}{status.mmkin}(x, ...)
+}
+\arguments{
+\item{object}{The object to investigate}
+
+\item{\dots}{For potential future extensions}
+
+\item{x}{The object to be printed}
+}
+\value{
+An object with the same dimensions as the fit array
+suitable printing method.
+}
+\description{
+Method to get status information for fit array objects
+}
+\examples{
+\dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS B" = FOCUS_2006_C),
+  quiet = TRUE)
+status(fits)
+}
+}
diff --git a/man/summary.mmkin.Rd b/man/summary.mmkin.Rd
index 69245621..32e5824f 100644
--- a/man/summary.mmkin.Rd
+++ b/man/summary.mmkin.Rd
@@ -21,7 +21,7 @@
 \item{digits}{number of digits to use for printing}
 }
 \description{
-Shows convergence information on the \link{mkinfit} objects contained in the object
+Shows status information on the \link{mkinfit} objects contained in the object
 and gives an overview of ill-defined parameters calculated by \link{illparms}.
 }
 \examples{
-- 
cgit v1.2.1