tex_summarystats: 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 geographic history inference in the study.

Description

Generate the description (in the selected format) of the geographic history inference in the study.

Usage

tex_summarystats(
  do_stochasticmapping = "",
  markovjumps_total = T,
  markovjumps_pairwise = T,
  format = c("HTML", "Latex", "Markdown"),
  render_citation = T
)

Arguments

do_stochasticmapping	Whether to perform stochastic mapping to simulate full histories of the discrete-geographic trait (default) or perform the "fast" stochastic mapping to compute the expected number of events on each branch
markovjumps_total	Whether to compute the number of events among all discrete states (default true) or not
markovjumps_pairwise	Whether to compute the number of events between each pair of discrete states (default true) or not
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 geographic history inference in the study.

Examples

tex_summarystats("Stochastic mapping (complete history, simulation-based)", TRUE, TRUE)

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