aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-11-13 22:16:43 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2019-11-13 22:28:28 +0100
commit51535c943d2846bc73ad69a11909aac606996b7d (patch)
treefbba72fdf391d2e80fb2152670f1d4872b8c991f
parente04fcfcfe06377ec180125e54fe4f458b0747a76 (diff)
Improve formatting using markdown
-rw-r--r--R/aw.R16
-rw-r--r--docs/reference/aw.html12
-rw-r--r--man/aw.Rd12
3 files changed, 19 insertions, 21 deletions
diff --git a/R/aw.R b/R/aw.R
index 24078f38..f46b20ec 100644
--- a/R/aw.R
+++ b/R/aw.R
@@ -4,16 +4,17 @@
#' expected Kullback-Leibler information as specified
#' by Burnham and Anderson (2004).
#'
-#' @param object An mmkin column object, containing two or more
-#' \code{\link{mkinfit}} models that have been fitted to the same data,
+#' @param 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.
-#' @param \dots Not used in the method for mmkin column objects,
-#' further mkinfit objects in the method for mkinfit objects.
+#' @param \dots 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
+#' Inference: Understanding AIC and BIC in Model Selection.
+#' *Sociological Methods & Research* **33**(2) 261-304
+#' @md
#' @examples
#' \dontrun{
#' f_sfo <- mkinfit("SFO", FOCUS_2006_D, quiet = TRUE)
@@ -55,6 +56,3 @@ aw.mmkin <- function(object, ...) {
if (ncol(object) > 1) stop("Please supply an mmkin column object")
do.call(aw, object)
}
-
-
-
diff --git a/docs/reference/aw.html b/docs/reference/aw.html
index b6f3ce48..22201229 100644
--- a/docs/reference/aw.html
+++ b/docs/reference/aw.html
@@ -153,24 +153,24 @@ by Burnham and Anderson (2004).</p>
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>object</th>
- <td><p>An mmkin column object, containing two or more
-<code><a href='mkinfit.html'>mkinfit</a></code> models that have been fitted to the same data,
+ <td><p>An <a href='mmkin.html'>mmkin</a> column object, containing two or more
+<a href='mkinfit.html'>mkinfit</a> 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.</p></td>
</tr>
<tr>
<th>...</th>
- <td><p>Not used in the method for mmkin column objects,
-further mkinfit objects in the method for mkinfit objects.</p></td>
+ <td><p>Not used in the method for <a href='mmkin.html'>mmkin</a> column objects,
+further <a href='mkinfit.html'>mkinfit</a> objects in the method for mkinfit objects.</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2>
<p>Burnham KP and Anderson DR (2004) Multimodel
- Inference: Understanding AIC and BIC in Model Selection
- Sociological Methods &amp; Research 33(2) 261-304</p>
+Inference: Understanding AIC and BIC in Model Selection.
+<em>Sociological Methods &amp; Research</em> <strong>33</strong>(2) 261-304</p>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='co'># \dontrun{</span>
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
}

Contact - Imprint