From 2bb59c88d49b193f278916ad9cc4de83c0de9604 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 2 Mar 2022 18:03:54 +0100 Subject: Make tests more platform independent, update docs --- docs/reference/Extract.mmkin.html | 287 +++++++++++++++----------------------- 1 file changed, 110 insertions(+), 177 deletions(-) (limited to 'docs/reference/Extract.mmkin.html') diff --git a/docs/reference/Extract.mmkin.html b/docs/reference/Extract.mmkin.html index b1c73ba5..49578dc7 100644 --- a/docs/reference/Extract.mmkin.html +++ b/docs/reference/Extract.mmkin.html @@ -1,67 +1,12 @@ - - - - - - - -Subsetting method for mmkin objects — [.mmkin • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Subsetting method for mmkin objects — [.mmkin • mkin + + - - - - -
-
- -
- -
+
@@ -147,122 +86,116 @@

Subsetting method for mmkin objects

-
# S3 method for mmkin
-[(x, i, j, ..., drop = FALSE)
- -

Arguments

- - - - - - - - - - - - - - - - - - - - - - -
x

An mmkin object

i

Row index selecting the fits for specific models

j

Column index selecting the fits to specific datasets

...

Not used, only there to satisfy the generic method definition

drop

If FALSE, the method always returns an mmkin object, otherwise -either a list of mkinfit objects or a single mkinfit object.

- -

Value

- -

An object of class mmkin.

-

Author

+
+
# S3 method for mmkin
+[(x, i, j, ..., drop = FALSE)
+
+
+

Arguments

+
x
+

An mmkin object

+
i
+

Row index selecting the fits for specific models

+
j
+

Column index selecting the fits to specific datasets

+
...
+

Not used, only there to satisfy the generic method definition

+
drop
+

If FALSE, the method always returns an mmkin object, otherwise +either a list of mkinfit objects or a single mkinfit object.

+
+
+

Value

+

An object of class mmkin.

+
+
+

Author

Johannes Ranke

+
-

Examples

-
- # Only use one core, to pass R CMD check --as-cran - fits <- mmkin(c("SFO", "FOMC"), list(B = FOCUS_2006_B, C = FOCUS_2006_C), - cores = 1, quiet = TRUE) - fits["FOMC", ] -
#> <mmkin> object -#> Status of individual fits: -#> -#> dataset -#> model B C -#> FOMC OK OK -#> -#> OK: No warnings
fits[, "B"] -
#> <mmkin> object -#> Status of individual fits: -#> -#> dataset -#> model B -#> SFO OK -#> FOMC OK -#> -#> OK: No warnings
fits["SFO", "B"] -
#> <mmkin> object -#> Status of individual fits: -#> -#> dataset -#> model B -#> SFO OK -#> -#> OK: No warnings
- head( - # This extracts an mkinfit object with lots of components - fits[["FOMC", "B"]] - ) -
#> $par -#> parent_0 log_alpha log_beta sigma -#> 99.666192 2.549850 5.050586 1.890202 -#> -#> $objective -#> [1] 28.58291 -#> -#> $convergence -#> [1] 0 -#> -#> $iterations -#> [1] 21 -#> -#> $evaluations -#> function gradient -#> 25 78 -#> -#> $message -#> [1] "both X-convergence and relative convergence (5)" -#>
+
+

Examples

+

+  # Only use one core, to pass R CMD check --as-cran
+  fits <- mmkin(c("SFO", "FOMC"), list(B = FOCUS_2006_B, C = FOCUS_2006_C),
+                cores = 1, quiet = TRUE)
+  fits["FOMC", ]
+#> <mmkin> object
+#> Status of individual fits:
+#> 
+#>       dataset
+#> model  B  C 
+#>   FOMC OK OK
+#> 
+#> OK: No warnings
+  fits[, "B"]
+#> <mmkin> object
+#> Status of individual fits:
+#> 
+#>       dataset
+#> model  B 
+#>   SFO  OK
+#>   FOMC OK
+#> 
+#> OK: No warnings
+  fits["SFO", "B"]
+#> <mmkin> object
+#> Status of individual fits:
+#> 
+#>      dataset
+#> model B 
+#>   SFO OK
+#> 
+#> OK: No warnings
+
+  head(
+    # This extracts an mkinfit object with lots of components
+    fits[["FOMC", "B"]]
+  )
+#> $par
+#>  parent_0 log_alpha  log_beta     sigma 
+#> 99.666192  2.549850  5.050586  1.890202 
+#> 
+#> $objective
+#> [1] 28.58291
+#> 
+#> $convergence
+#> [1] 0
+#> 
+#> $iterations
+#> [1] 21
+#> 
+#> $evaluations
+#> function gradient 
+#>       25       78 
+#> 
+#> $message
+#> [1] "both X-convergence and relative convergence (5)"
+#> 
+
+
+
- - - + + -- cgit v1.2.1