From cff25a78e0e5a9d46db575b1ae3b02ace560aaf6 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 22 Jul 2022 11:43:49 +0200 Subject: Update static docs --- docs/reference/illparms.html | 171 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 171 insertions(+) create mode 100644 docs/reference/illparms.html (limited to 'docs/reference/illparms.html') diff --git a/docs/reference/illparms.html b/docs/reference/illparms.html new file mode 100644 index 00000000..037d7a8c --- /dev/null +++ b/docs/reference/illparms.html @@ -0,0 +1,171 @@ + +Method to get the names of ill-defined parameters — illparms • mkin + + +
+
+ + + +
+
+
+

Method to get the names of ill-defined parameters

+ Source: R/illparms.R + +
+ +
+

Method to get the names of ill-defined parameters

+
+ +
+ 
illparms(object, ...)
+
+# S3 method for mkinfit
+illparms(object, conf.level = 0.95, ...)
+
+# S3 method for mmkin
+illparms(object, conf.level = 0.95, ...)
+
+# S3 method for illparms.mmkin
+print(x, ...)
+
+ +
+

Arguments

+
object
+

The object to investigate

+ + +
...
+

For potential future extensions

+ + +
conf.level
+

The confidence level for checking p values

+ + +
x
+

The object to be printed

+ +
+
+

Value

+ + +

For mkinfit objects, a character vector of parameter names +For mmkin objects, an object of class 'illparms.mmkin' with a +suitable printing method.

+
+ +
+

Examples

+ 
fit <- mkinfit("FOMC", FOCUS_2006_A, quiet = TRUE)
+illparms(fit)
+#> [1] "parent_0" "alpha"    "beta"     "sigma"   
+# \dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS C" = FOCUS_2006_C),
+  quiet = TRUE)
+illparms(fits)
+#>       dataset
+#> model  FOCUS A                      FOCUS C
+#>   SFO                                      
+#>   FOMC parent_0, alpha, beta, sigma        
+# }
+
+
+
+ +
+ + +
+ + + + + + + + -- cgit v1.2.1