aboutsummaryrefslogtreecommitdiff
path: root/R
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 /R
parente04fcfcfe06377ec180125e54fe4f458b0747a76 (diff)
Improve formatting using markdown
Diffstat (limited to 'R')
-rw-r--r--R/aw.R16
1 files changed, 7 insertions, 9 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)
}
-
-
-

Contact - Imprint