From 6178249bbb5e9de7cb7f34287ee7de28a68fed6c Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 10 Aug 2022 15:38:17 +0200 Subject: Change dev branch used for docs, update static docs --- docs/dev/reference/convergence.html | 163 ++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 docs/dev/reference/convergence.html (limited to 'docs/dev/reference/convergence.html') diff --git a/docs/dev/reference/convergence.html b/docs/dev/reference/convergence.html new file mode 100644 index 00000000..e9fac3bb --- /dev/null +++ b/docs/dev/reference/convergence.html @@ -0,0 +1,163 @@ + +Method to get convergence information — convergence • mkin + + +
+
+ + + +
+
+
+

Method to get convergence information

+ Source: R/convergence.R + +
+ +
+

Method to get convergence information

+
+ +
+ 
convergence(object, ...)
+
+# S3 method for mmkin
+convergence(object, ...)
+
+# S3 method for convergence.mmkin
+print(x, ...)
+
+ +
+

Arguments

+
object
+

The object to investigate

+ + +
...
+

For potential future extensions

+ + +
x
+

The object to be printed

+ +
+
+

Value

+ + +

For mkinfit objects, a character vector containing +For mmkin objects, an object of class 'convergence.mmkin' with a +suitable printing method.

+
+ +
+

Examples

+ 
# \dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS B" = FOCUS_2006_C),
+  quiet = TRUE)
+convergence(fits)
+#>       dataset
+#> model  FOCUS A FOCUS B
+#>   SFO  OK      OK     
+#>   FOMC OK      OK     
+#> 
+#> OK: No warnings
+# }
+
+
+
+ +
+ + +
+ + + + + + + + -- cgit v1.2.1