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/convergence.html | 163 +++++++++++++++++++++++++++++++++ docs/reference/illparms.html | 171 +++++++++++++++++++++++++++++++++++ docs/reference/index.html | 14 ++- docs/reference/summary.mkinfit.html | 67 ++++++++++---- docs/reference/summary.mmkin.html | 173 ++++++++++++++++++++++++++++++++++++ 5 files changed, 568 insertions(+), 20 deletions(-) create mode 100644 docs/reference/convergence.html create mode 100644 docs/reference/illparms.html create mode 100644 docs/reference/summary.mmkin.html (limited to 'docs/reference') diff --git a/docs/reference/convergence.html b/docs/reference/convergence.html new file mode 100644 index 00000000..3c7d5536 --- /dev/null +++ b/docs/reference/convergence.html @@ -0,0 +1,163 @@ + +Method to get convergence information — convergence • mkin + + +
+
+ + + +
+
+
+

Method to get convergence information

+ Source: R/convergence.R + +
+ +
+

Method to get convergence information

+
+ +
+ 
convergence(object, ...)
+
+# S3 method for mmkin
+convergence(object, ...)
+
+# S3 method for convergence.mmkin
+print(x, ...)
+
+ +
+

Arguments

+
object
+

The object to investigate

+ + +
...
+

For potential future extensions

+ + +
x
+

The object to be printed

+ +
+
+

Value

+ + +

For mkinfit objects, a character vector containing +For mmkin objects, an object of class 'convergence.mmkin' with a +suitable printing method.

+
+ +
+

Examples

+ 
# \dontrun{
+fits <- mmkin(
+  c("SFO", "FOMC"),
+  list("FOCUS A" = FOCUS_2006_A,
+       "FOCUS B" = FOCUS_2006_C),
+  quiet = TRUE)
+convergence(fits)
+#>       dataset
+#> model  FOCUS A FOCUS B
+#>   SFO  OK      OK     
+#>   FOMC OK      OK     
+#> 
+#> OK: No warnings
+# }
+
+
+
+ +
+ + +
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown 2.0.5.

+
+ +
+ + + + + + + + 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        
+# }
+
+
+
+ +
+ + +
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown 2.0.5.

+
+ +
+ + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 63e3de8f..482edf08 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -17,7 +17,7 @@ mkin - 1.1.1 + 1.1.2 @@ -167,6 +167,18 @@ of an mmkin object

AIC(<mmkin>) BIC(<mmkin>)

Calculate the AIC for a column of an mmkin object

+ +

convergence() print(<convergence.mmkin>)

+ +

Method to get convergence information

+ +

illparms() print(<illparms.mmkin>)

+ +

Method to get the names of ill-defined parameters

+ +

summary(<mmkin>) print(<summary.mmkin>)

+ +

Summary method for class "mmkin"

Mixed models

Create and work with nonlinear mixed effects models

diff --git a/docs/reference/summary.mkinfit.html b/docs/reference/summary.mkinfit.html index 6d816366..17ecdfe4 100644 --- a/docs/reference/summary.mkinfit.html +++ b/docs/reference/summary.mkinfit.html @@ -21,7 +21,7 @@ values."> + + +
+
+ + + +
+
+
+

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.607 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