Skip to content

Commit

Permalink
Manually anchor the mcmc.list documentation links.
Browse files Browse the repository at this point in the history
  • Loading branch information
krivit committed Oct 1, 2024
1 parent 31e7e1d commit d199507
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
16 changes: 8 additions & 8 deletions R/mcmc-utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
# Copyright 2007-2024 Statnet Commons
################################################################################
#' @name mcmc-utilities
#' @title Utility operations for [`mcmc.list`] objects
#' @title Utility operations for [`mcmc.list`][coda::mcmc.list] objects
#'
#' @description \code{colMeans.mcmc.list} is a "method" for (non-generic) [colMeans()] applicable to [`mcmc.list`] objects.
#' @description \code{colMeans.mcmc.list} is a "method" for (non-generic) [colMeans()] applicable to [`mcmc.list`][coda::mcmc.list] objects.
#'
#' @param x a \code{\link{mcmc.list}} object.
#' @param \dots additional arguments to the functions evaluated on each chain.
Expand All @@ -22,7 +22,7 @@
#' numerical error) to the same function being called on
#' `as.matrix(x)`, while avoiding construction of the large matrix.
#'
#' @seealso [`mcmc.list`]
#' @seealso [`mcmc.list`][coda::mcmc.list]
#'
#' [colMeans()]
#' @examples
Expand All @@ -41,7 +41,7 @@ colMeans.mcmc.list <- function(x,...){
#' @rdname mcmc-utilities
#'
#' @description \code{var.mcmc.list} is a "method" for (non-generic)
#' [var()] applicable to [`mcmc.list`] objects. Since MCMC chains
#' [var()] applicable to [`mcmc.list`][coda::mcmc.list] objects. Since MCMC chains
#' are assumed to all be sampling from the same underlying
#' distribution, their pooled mean is used.
#'
Expand All @@ -66,7 +66,7 @@ var.mcmc.list <- function(x, ...){
#' @rdname mcmc-utilities
#'
#' @description \code{sweep.mcmc.list} is a "method" for (non-generic)
#' [sweep()] applicable to [`mcmc.list`] objects.
#' [sweep()] applicable to [`mcmc.list`][coda::mcmc.list] objects.
#'
#' @param STATS,FUN,check.margin See help for [sweep()].
#' @return \code{sweep.mcmc.list} returns an appropriately modified
Expand All @@ -90,10 +90,10 @@ sweep.mcmc.list<-function(x, STATS, FUN="-", check.margin=TRUE, ...){
#' @rdname mcmc-utilities
#'
#' @description \code{lapply.mcmc.list} is a "method" for (non-generic)
#' [lapply()] applicable to [`mcmc.list`] objects.
#' [lapply()] applicable to [`mcmc.list`][coda::mcmc.list] objects.
#'
#' @param X An [`mcmc.list`] object.
#' @return `lapply.mcmc.list` returns an [`mcmc.list`] each of
#' @param X An [`mcmc.list`][coda::mcmc.list] object.
#' @return `lapply.mcmc.list` returns an [`mcmc.list`][coda::mcmc.list] each of
#' whose chains had been passed through `FUN`.
#' @seealso [lapply()]
#' @examples
Expand Down
16 changes: 8 additions & 8 deletions man/mcmc-utilities.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d199507

Please sign in to comment.