aboutsummaryrefslogtreecommitdiff
path: root/man/convergence.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2022-10-28 10:31:16 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2022-10-28 10:31:16 +0200
commit4c868d65be04c8ee3fedc89d28d0e7d8c5da05e0 (patch)
tree6aa3123f7b722bcffdbdc06c06abe867726c8b91 /man/convergence.Rd
parent0e9220c6b9132602a3d69e4be582a02da8b07822 (diff)
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.
Diffstat (limited to 'man/convergence.Rd')
-rw-r--r--man/convergence.Rd39
1 files changed, 0 insertions, 39 deletions
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)
-}
-}

Contact - Imprint