From c3700bec3a704660d3ade7a54c56b7084beb02b4 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Wed, 13 Nov 2019 21:15:35 +0100
Subject: Calculate Akaike weights

---
 man/aw.Rd | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 man/aw.Rd

(limited to 'man/aw.Rd')

diff --git a/man/aw.Rd b/man/aw.Rd
new file mode 100644
index 00000000..f0994b94
--- /dev/null
+++ b/man/aw.Rd
@@ -0,0 +1,47 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/aw.R
+\name{aw}
+\alias{aw}
+\alias{aw.mkinfit}
+\alias{aw.mmkin}
+\title{Calculate Akaike weights for model averaging}
+\usage{
+aw(object, ...)
+
+\method{aw}{mkinfit}(object, ...)
+
+\method{aw}{mmkin}(object, ...)
+}
+\arguments{
+\item{object}{An mmkin column object, containing two or more
+\code{\link{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.}
+
+\item{\dots}{Not used in the method for mmkin column objects,
+further mkinfit objects in the method for mkinfit objects.}
+}
+\description{
+Akaike weights are calculated based on the relative
+expected Kullback-Leibler information as specified
+by Burnham and Anderson (2004).
+}
+\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)
+aw_sfo_dfop # SFO gets more weight as it has less parameters and a similar fit
+f <- mmkin(c("SFO", "FOMC", "DFOP"), list("FOCUS D" = FOCUS_2006_D), cores = 1, quiet = TRUE)
+aw(f)
+sum(aw(f))
+aw(f[c("SFO", "DFOP")])
+}
+}
+\references{
+Burnham KP and Anderson DR (2004) Multimodel
+  Inference: Understanding AIC and BIC in Model Selection
+  Sociological Methods & Research 33(2) 261-304
+}
-- 
cgit v1.2.1


From 51535c943d2846bc73ad69a11909aac606996b7d Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Wed, 13 Nov 2019 22:16:43 +0100
Subject: Improve formatting using markdown

---
 man/aw.Rd | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'man/aw.Rd')

diff --git a/man/aw.Rd b/man/aw.Rd
index f0994b94..40676716 100644
--- a/man/aw.Rd
+++ b/man/aw.Rd
@@ -13,14 +13,14 @@ aw(object, ...)
 \method{aw}{mmkin}(object, ...)
 }
 \arguments{
-\item{object}{An mmkin column object, containing two or more
-\code{\link{mkinfit}} models that have been fitted to the same data,
+\item{object}{An \link{mmkin} column object, containing two or more
+\link{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.}
 
-\item{\dots}{Not used in the method for mmkin column objects,
-further mkinfit objects in the method for mkinfit objects.}
+\item{\dots}{Not used in the method for \link{mmkin} column objects,
+further \link{mkinfit} objects in the method for mkinfit objects.}
 }
 \description{
 Akaike weights are calculated based on the relative
@@ -42,6 +42,6 @@ aw(f[c("SFO", "DFOP")])
 }
 \references{
 Burnham KP and Anderson DR (2004) Multimodel
-  Inference: Understanding AIC and BIC in Model Selection
-  Sociological Methods & Research 33(2) 261-304
+Inference: Understanding AIC and BIC in Model Selection.
+\emph{Sociological Methods & Research} \strong{33}(2) 261-304
 }
-- 
cgit v1.2.1