From 2a521ab0a4b7d981a2042353e2c60b8a877489b8 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 16 Sep 2022 10:51:48 +0200 Subject: Improve docs and update pkgdown --- docs/dev/reference/aw.html | 202 +++++++++++++++++---------------------------- 1 file changed, 75 insertions(+), 127 deletions(-) (limited to 'docs/dev/reference/aw.html') diff --git a/docs/dev/reference/aw.html b/docs/dev/reference/aw.html index 3b06f2a6..57dfa06c 100644 --- a/docs/dev/reference/aw.html +++ b/docs/dev/reference/aw.html @@ -1,69 +1,14 @@ - - - - - - - -Calculate Akaike weights for model averaging — aw • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Calculate Akaike weights for model averaging — aw • mkin - - - - - - - - - + + - - - - -
-
- -
- -
+

Calculate Akaike weights for model averaging

- Source: R/aw.R + Source: R/aw.R
@@ -151,76 +90,85 @@ expected Kullback-Leibler information as specified by Burnham and Anderson (2004).

- 
aw(object, ...)
-
-# S3 method for mkinfit
-aw(object, ...)
-
-# S3 method for mmkin
-aw(object, ...)
+
+ 
aw(object, ...)
+
+# S3 method for mkinfit
+aw(object, ...)
+
+# S3 method for mmkin
+aw(object, ...)
+
+# S3 method for mixed.mmkin
+aw(object, ...)
+
+# S3 method for multistart
+aw(object, ...)
+
-

Arguments

- - - - - - - - - - -
object

An mmkin column object, containing two or more -mkinfit models that have been fitted to the same data, +

+

Arguments

+
object
+

An mmkin column object, containing two or more +mkinfit models that have been fitted to the same data, or an mkinfit object. In the latter case, further mkinfit objects fitted to the same data should be specified -as dots arguments.

...

Not used in the method for mmkin column objects, -further mkinfit objects in the method for mkinfit objects.

+as dots arguments.

+ -

References

+
...
+

Not used in the method for mmkin column objects, +further mkinfit objects in the method for mkinfit objects.

+
+
+

References

Burnham KP and Anderson DR (2004) Multimodel Inference: Understanding AIC and BIC in Model Selection. Sociological Methods & Research 33(2) 261-304

+
-

Examples

- 
# \dontrun{
-f_sfo <- mkinfit("SFO", FOCUS_2006_D, quiet = TRUE)
-f_dfop <- mkinfit("DFOP", FOCUS_2006_D, quiet = TRUE)
-aw_sfo_dfop <- aw(f_sfo, f_dfop)
-sum(aw_sfo_dfop)
-
#> [1] 1
aw_sfo_dfop # SFO gets more weight as it has less parameters and a similar fit
-
#> [1] 0.5970258 0.4029742
f <- mmkin(c("SFO", "FOMC", "DFOP"), list("FOCUS D" = FOCUS_2006_D), cores = 1, quiet = TRUE)
-aw(f)
-
#> [1] 0.4808722 0.1945539 0.3245740
sum(aw(f))
-
#> [1] 1
aw(f[c("SFO", "DFOP")])
-
#> [1] 0.5970258 0.4029742
# }
-
+
+

Examples

+ 
# \dontrun{
+f_sfo <- mkinfit("SFO", FOCUS_2006_D, quiet = TRUE)
+f_dfop <- mkinfit("DFOP", FOCUS_2006_D, quiet = TRUE)
+aw_sfo_dfop <- aw(f_sfo, f_dfop)
+sum(aw_sfo_dfop)
+#> [1] 1
+aw_sfo_dfop # SFO gets more weight as it has less parameters and a similar fit
+#> [1] 0.5970258 0.4029742
+f <- mmkin(c("SFO", "FOMC", "DFOP"), list("FOCUS D" = FOCUS_2006_D), cores = 1, quiet = TRUE)
+aw(f)
+#> [1] 0.4808722 0.1945539 0.3245740
+sum(aw(f))
+#> [1] 1
+aw(f[c("SFO", "DFOP")])
+#> [1] 0.5970258 0.4029742
+# }
+
+
+
- - - + + -- cgit v1.2.1