format_bf: Bayes Factor formatting

In insight: Easy Access to Model Information for Various Model Objects

Bayes Factor formatting

Description

Bayes Factor formatting

Usage

format_bf(
  bf,
  stars = FALSE,
  stars_only = FALSE,
  name = "BF",
  protect_ratio = FALSE,
  na_reference = NA,
  exact = FALSE
)

Arguments

bf	Bayes Factor.
stars	Add significance stars (e.g., p < .001***).
stars_only	Return only significance stars.
name	Name prefixing the text. Can be NULL.
protect_ratio	Should values smaller than 1 be represented as ratios?
na_reference	How to format missing values (NA).
exact	Should very large or very small values be reported with a scientific format (e.g., 4.24e5), or as truncated values (as "> 1000" and "< 1/1000").

Value

A formatted string.

Examples

format_bf(bfs <- c(0.000045, 0.033, NA, 1557, 3.54))
format_bf(bfs, exact = TRUE, name = NULL)
format_bf(bfs, stars = TRUE)
format_bf(bfs, protect_ratio = TRUE)
format_bf(bfs, protect_ratio = TRUE, exact = TRUE)
format_bf(bfs, na_reference = 1)

insight documentation built on Nov. 26, 2023, 5:08 p.m.