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/summary.mmkin.html | 173 ++++++++++++++++++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 docs/dev/reference/summary.mmkin.html (limited to 'docs/dev/reference/summary.mmkin.html') diff --git a/docs/dev/reference/summary.mmkin.html b/docs/dev/reference/summary.mmkin.html new file mode 100644 index 00000000..e916ba24 --- /dev/null +++ b/docs/dev/reference/summary.mmkin.html @@ -0,0 +1,173 @@ + +Summary method for class "mmkin" — summary.mmkin • mkin + + +
+
+ + + +
+
+
+

Summary method for class "mmkin"

+ Source: R/summary.mmkin.R + +
+ +
+

Shows convergence information on the mkinfit objects contained in the object +and gives an overview of ill-defined parameters calculated by illparms.

+
+ +
+ 
# S3 method for mmkin
+summary(object, conf.level = 0.95, ...)
+
+# S3 method for summary.mmkin
+print(x, digits = max(3, getOption("digits") - 3), ...)
+
+ +
+

Arguments

+
object
+

an object of class mmkin

+ + +
conf.level
+

confidence level for testing parameters

+ + +
...
+

optional arguments passed to methods like print.

+ + +
x
+

an object of class summary.mmkin.

+ + +
digits
+

number of digits to use for printing

+ +
+ +
+

Examples

+ 

+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS C" = FOCUS_2006_C),
+  quiet = TRUE, cores = 1)
+  summary(fits)
+#> Error model: Constant variance 
+#> Fitted in 0.802 s
+#> 
+#> Convergence:
+#>       dataset
+#> model  FOCUS A FOCUS C
+#>   SFO  OK      OK     
+#>   FOMC OK      OK     
+#> 
+#> OK: No warnings
+#> 
+#> Ill-defined parameters:
+#>       dataset
+#> model  FOCUS A                      FOCUS C
+#>   SFO                                      
+#>   FOMC parent_0, alpha, beta, sigma        
+
+
+
+
+ +
+ + +
+ + + + + + + + -- cgit v1.2.1