From 59566e315c5d05a0aa4a46ab80c5fda33c5c2f1e Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sat, 29 Oct 2022 00:36:22 +0200 Subject: Update multistart docs --- docs/dev/reference/status.html | 171 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 171 insertions(+) create mode 100644 docs/dev/reference/status.html (limited to 'docs/dev/reference/status.html') diff --git a/docs/dev/reference/status.html b/docs/dev/reference/status.html new file mode 100644 index 00000000..778446b3 --- /dev/null +++ b/docs/dev/reference/status.html @@ -0,0 +1,171 @@ + +Method to get status information for fit array objects — status • mkin + + +
+
+ + + +
+
+
+

Method to get status information for fit array objects

+ Source: R/status.R + +
+ +
+

Method to get status information for fit array objects

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

Arguments

+
object
+

The object to investigate

+ + +
...
+

For potential future extensions

+ + +
x
+

The object to be printed

+ +
+
+

Value

+ + +

An object with the same dimensions as the fit array +suitable printing method.

+
+ +
+

Examples

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