fbseq: Function 'fbseq'

In wlandau/fbseq: fbseq

Description

Top-level function. Runs an MCMC with the runtime parameters specified in the Chain object

Usage

fbseq(chain, additional_chains = 3, backend = "CUDA", processes = 1,
  threads = 1)

Arguments

chain	object of type Chain. See the package vignette for details.
additional_chains	If > 0, additional_chains additional Chain objects will be created from the original chain argument and run. This is useful for calculating convergence diagnostics such as Gelman-Rubin potential scale reduction factors. The additional chains will be run after the first chain and have starting values overdispersed to the full joint posterior distribution, as estimated by the results of the first chain.
backend	Backend for parallel computing. Options are "CUDA" and "OpenMP".
processes	number of CPU processes to fork for the additional chains. This argument is automatically reset to 1 for non-serial backends because additional parallel::mclapply processes interfere with other modes of parallelism. For some other backends, chains will be distributed accross processes.
threads	Number of threads for the OpenMP implementation.

Value

a Chain object or a list of Chain objects, depending on the value of additional_chains.

wlandau/fbseq documentation built on May 4, 2019, 8:43 a.m.