R/collapse-chains.R

Defines functions collapse_chains.nlists collapse_chains.nlist collapse_chains.mcmc.list collapse_chains.mcmc

Documented in collapse_chains.mcmc collapse_chains.mcmc.list collapse_chains.nlist collapse_chains.nlists

#' @export
universals::collapse_chains

#' @inherit universals::collapse_chains
#' @details
#' As mcmc objects can only have 1 chain the object is unchanged.
#' @family collapse
#' @export
#'
#' @examples
#' collapse_chains(as_mcmc(nlist(x = 2)))
collapse_chains.mcmc <- function(x, ...) x

#' @inherit universals::collapse_chains
#' @export
collapse_chains.mcmc.list <- function(x, ...) {
  as.mcmc.list(Reduce(bind_iterations, x))
}

#' @inherit universals::collapse_chains
#' @details
#' As nlist objects can only have 1 chain the object is unchanged.
#' @family collapse
#' @export
#'
#' @examples
#' collapse_chains(nlist(x = 2))
collapse_chains.nlist <- function(x, ...) {
  x
}

#' @inherit universals::collapse_chains
#' @family collapse
#' @export
#'
#' @examples
#' collapse_chains(nlist(x = 2))
#' @export
collapse_chains.nlists <- function(x, ...) {
  attr(x, "nchains") <- NULL
  x
}

Try the nlist package in your browser

Any scripts or data that you put into this service are public.

nlist documentation built on Sept. 5, 2021, 6:05 p.m.