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/illparms.html | 207 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 207 insertions(+) create mode 100644 docs/dev/reference/illparms.html (limited to 'docs/dev/reference/illparms.html') diff --git a/docs/dev/reference/illparms.html b/docs/dev/reference/illparms.html new file mode 100644 index 00000000..184299ed --- /dev/null +++ b/docs/dev/reference/illparms.html @@ -0,0 +1,207 @@ + +Method to get the names of ill-defined parameters — illparms • mkin + + +
+
+ + + +
+
+
+

Method to get the names of ill-defined parameters

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

The method for generalised nonlinear regression fits as obtained +with mkinfit and mmkin checks if the degradation parameters +pass the Wald test (in degradation kinetics often simply called t-test) for +significant difference from zero. For this test, the parameterisation +without parameter transformations is used.

+
+ +
+ 
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, ...)
+
+# S3 method for saem.mmkin
+illparms(object, conf.level = 0.95, random = TRUE, errmod = TRUE, ...)
+
+# S3 method for mhmkin
+illparms(object, conf.level = 0.95, random = TRUE, errmod = TRUE, ...)
+
+# S3 method for illparms.mhmkin
+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

+ + +
random
+

For hierarchical fits, should random effects be tested?

+ + +
errmod
+

For hierarchical fits, should error model parameters be +tested?

+ +
+
+

Value

+ + +

For mkinfit or saem objects, a character vector of parameter +names. For mmkin or mhmkin objects, a matrix like object of class +'illparms.mmkin' or 'illparms.mhmkin'. The latter objects have a suitable +printing method.

+
+
+

Details

+

The method for hierarchical model fits, also known as nonlinear +mixed-effects model fits as obtained with saem and mhmkin +checks if any of the confidence intervals for the random +effects expressed as standard deviations include zero, and if +the confidence intervals for the error model parameters include +zero.

+
+ +
+

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