tex_powerposterior: Generate the description (in the selected format) of the...

In jsigao/prioritree: A utility for improving phylodynamic analyses in BEAST

Generate the description (in the selected format) of the power-posterior analysis used in the study.

Description

Generate the description (in the selected format) of the power-posterior analysis used in the study.

Usage

tex_powerposterior(
  ml_numstones = 0,
  ml_chainlengthperstone = 0,
  ml_samplingfreq = 0,
  ml_alphaofbeta = 0.3,
  mcmc_numreplicates = 2,
  format = c("HTML", "Latex", "Markdown"),
  render_citation = T
)

Arguments

ml_numstones	Number of powers ("stones") to use in the power-posterior analysis.
ml_chainlengthperstone	Number of generations to run per stone.
ml_samplingfreq	Every number of generations to log to the output.
ml_alphaofbeta	Alpha of the Beta distribution that decides where to put the stones.
mcmc_numreplicates	Number of MCMC replicates to run.
format	One of "HTML", "Latex", or "Markdown".
render_citation	Whether the reference list will be rendered at the end of the methods document (default true; false when just showing the description in the HTML panel).

Value

A paragraph (in the selected format) describing the power-posterior analysis used in the study.

Examples

tex_powerposterior(ml_numstones = 64, ml_chainlengthperstone = 500000, ml_samplingfreq = 1000, ml_alphaofbeta = 0.3, mcmc_numreplicates = 2)

jsigao/prioritree documentation built on Jan. 9, 2023, 5:35 a.m.