aboutsummaryrefslogtreecommitdiff
path: root/R/summary.mmkin.R
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 /R/summary.mmkin.R
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 'R/summary.mmkin.R')
-rw-r--r--R/summary.mmkin.R8
1 files changed, 4 insertions, 4 deletions
diff --git a/R/summary.mmkin.R b/R/summary.mmkin.R
index 5f4a048b..06472e18 100644
--- a/R/summary.mmkin.R
+++ b/R/summary.mmkin.R
@@ -1,6 +1,6 @@
#' Summary method for class "mmkin"
#'
-#' Shows convergence information on the [mkinfit] objects contained in the object
+#' Shows status information on the [mkinfit] objects contained in the object
#' and gives an overview of ill-defined parameters calculated by [illparms].
#'
#' @param object an object of class [mmkin]
@@ -24,7 +24,7 @@ summary.mmkin <- function(object, conf.level = 0.95, ...) {
err_mod = object[[1, 1]]$err_mod,
time = attr(object, "time"),
illparms = illparms(object),
- convergence = convergence(object)
+ status = status(object)
)
class(ans) <- c("summary.mmkin")
@@ -43,8 +43,8 @@ print.summary.mmkin <- function(x, digits = max(3, getOption("digits") - 3), ...
}
cat("Fitted in", x$time[["elapsed"]], "s\n")
- cat("\nConvergence:\n")
- print(x$convergence)
+ cat("\nStatus:\n")
+ print(x$status)
if (any(x$illparms != "")) {
cat("\nIll-defined parameters:\n")

Contact - Imprint