tidyBF (version 0.4.0)

bf_expr_template: Expression template for Bayes Factor results

Description

Expression template for Bayes Factor results

Usage

bf_expr_template(
  top.text,
  prior.type = quote(italic("r")["Cauchy"]^"JZS"),
  estimate.type = quote(delta),
  estimate.df,
  centrality = "median",
  conf.level = 0.95,
  conf.method = "HDI",
  k = 2L,
  ...
)

Arguments

top.text

Text to display as top.text (will be displayed on top of the Bayes Factor top.text/message).

prior.type

A character that specifies the prior type.

estimate.type

A character that specifies the relevant effect size.

estimate.df

Dataframe containing estimates and their credible intervals along with Bayes Factor value. The columns should be named as estimate, estimate.LB, estimate.UB, and bf10.

centrality

The point-estimates (centrality indices) to compute. Character (vector) or list with one or more of these options: "median", "mean", "MAP" or "all".

conf.level

Confidence/Credible Interval (CI) level. Default to 0.95 (95%).

conf.method

The type of index used for Credible Interval. Can be "hdi" (default, see bayestestR::hdi()), "eti" (see bayestestR::eti()) or "si" (see bayestestR::si()).

k

Number of digits after decimal point (should be an integer) (Default: k = 2L).

...

Currently ignored.