bf_caption_maker

0th

Percentile

Prepare caption with bayes factor in favor of null

Convenience function to write a caption message with bayes factors in favor of the null hypothesis.

Usage
bf_caption_maker(bf.df, k = 2, caption = NULL, ...)
Arguments
bf.df

A dataframe containing two columns log_e_bf01 and bf.prior. If dataframe contains more than two rows, only the first row will be used.

k

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

caption

Text to display as caption (will be displayed on top of the bayes factor caption/message).

...

Additional arguments (ignored).

Aliases
  • bf_caption_maker
Examples
# NOT RUN {
set.seed(123)

# dataframe containing results
bf_results <-
  bf_extractor(BayesFactor::correlationBF(
    x = iris$Sepal.Length,
    y = iris$Petal.Length
  )) %>%
  dplyr::mutate(.data = ., bf.prior = 0.707)

# creating caption
ggstatsplot::bf_caption_maker(
  bf.df = bf_results,
  k = 3,
  caption = "Note: Iris dataset"
)
# }
Documentation reproduced from package ggstatsplot, version 0.0.10, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.