From 91a5834dd701211f929fd25419dc34561ce3b4e7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 14 Feb 2025 09:15:20 +0100 Subject: Initialize dev docs --- docs/dev/reference/status.html | 145 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 145 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..e6388137 --- /dev/null +++ b/docs/dev/reference/status.html @@ -0,0 +1,145 @@ + +Method to get status information for fit array objects — status • mkin + Skip to contents + + +
+
+
+ +

Method to get status information for fit array objects

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

Method to get status information for fit array objects

+
+ +
+

Usage

+ 
status(object, ...)
+
+# S3 method for class 'mmkin'
+status(object, ...)
+
+# S3 method for class 'status.mmkin'
+print(x, ...)
+
+# S3 method for class 'mhmkin'
+status(object, ...)
+
+# S3 method for class '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 C       OK     
+#> 
+#> C: Optimisation did not converge:
+#> false convergence (8)
+#> OK: No warnings
+# }
+
+
+
+ + +
+ + + + + + + -- cgit v1.2.1