readMCMC_Mk: Read output files of MCMC for the predictor regimes.
In Caetanods/ratematrix: Bayesian Estimation of the Evolutionary Rate Matrix

readMCMC_Mk

R Documentation

Read output files of MCMC for the predictor regimes.

Description

Read the results of the MCMC chain for the predictor regimes.

Usage

readMCMC_Mk(
  handle,
  burn = 0,
  thin = 1,
  dir = NULL,
  return_Simmap = FALSE,
  nsims = 10,
  max_nshifts = 10000
)

Arguments

`handle`	the output of the 'ratematrixJointMCMC' function.
`burn`	the proportion of the burnin to be pruned from the MCMC chain. A number between 0 and 1 (default is 0).
`thin`	the thinning of the posterior distribution. A number with the interval between each MCMC step to be kept in the posterior distribution (default is 1).
`dir`	directory with the output files. If 'NULL' (default), then files are read from the directory chosen when running the MCMC chain using the argument 'dir' of the 'ratematrixJointMCMC' function (stored on handle). Otherwise function will read files from 'dir'.
`return_Simmap`	if the output should be stochastic mapping simulations conditioned on a sample of Q matrices from the posterior distribution (TRUE) or a list of sampled Q matrices.
`nsims`	number of stochastic mapping simulations to be done. These are based on the last 'nsims' sampled by the MCMC.
`max_nshifts`	the maximum number of state transitions in any branch of the phylogeny when making stochastic mapping simulations. If you get errors in the stochastic mapping step, try increasing this value. However, this indicates a VERY fast transition rate. See 'fastSimmap' function for more information.

Details

Function will use 'readr' package to read the output files produced by the Markov chain Monte Carlo analysis focused on the transition rates between the predictor states (the Mk model) made as part of the 'ratematrixJointMCMC' analysis.