From e5d1df9a9b1f0951d7dfbaf24eee4294470b73e2 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 17 Nov 2022 14:54:20 +0100 Subject: Complete update of online docs for v1.2.0 --- docs/reference/status.html | 174 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 174 insertions(+) create mode 100644 docs/reference/status.html (limited to 'docs/reference/status.html') diff --git a/docs/reference/status.html b/docs/reference/status.html new file mode 100644 index 00000000..8adf0113 --- /dev/null +++ b/docs/reference/status.html @@ -0,0 +1,174 @@ + +Method to get status information for fit array objects — status • mkin + + +
+
+ + + +
+
+ + +
+

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