tex_model: 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 model specified in the study.

Description

Generate the description (in the selected format) of the model specified in the study.

Usage

tex_model(
  bssvs = T,
  symmetry = T,
  format = c("HTML", "Latex", "Markdown"),
  render_citation = T
)

Arguments

bssvs	Whether Bayesian Stochastic Search Variable Selection (BSSVS) is used (default true) in the discrete-geographic model.
symmetry	Whether the discrete-geographic mode is symmetric (default true) or asymmetric.
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 model specified in the study.

Examples

tex_model(TRUE, TRUE, "Markdown", TRUE)

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