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

View source: R/tex_helpr.R

tex_bayesianinferenceR Documentation

Generate the description (in the selected format) of the Bayesian inference procedure used in the study.

Description

Generate the description (in the selected format) of the Bayesian inference procedure used in the study.

Usage

tex_bayesianinference(
  empiricaltree_mh = T,
  tree_num = 1,
  bssvs = T,
  format = c("HTML", "Latex", "Markdown"),
  render_citation = T
)

Arguments

empiricaltree_mh

Whether treating the provided distribution of trees as part of the Markov chain (default true) or averaging over the distribution uniformly.

tree_num

Number of phylogenetic trees to condition on (1 when the tree is fixed).

bssvs

Whether Bayesian Stochastic Search Variable Selection (BSSVS) is used (default true) in the discrete-geographic model.

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 Bayesian inference procedure used in the study.

Examples

tex_bayesianinference(TRUE, 1, TRUE)

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