ggstatsplot (version 0.0.11)

bf_caption_maker: Prepare caption with bayes factor in favor of null

Description

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

Usage

bf_caption_maker(bf.df, k = 2, output = "null", caption = NULL, ...)

Arguments

bf.df

A dataframe containing two columns log_e_bf01 (for evidence in favor of null hypothesis) 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).

output

Can either be "null" (or "caption" or "H0", which will contain text for evidence in favor of the null hypothesis or H0) or "alternative" (or "title" or "H1") or "results", which will return a dataframe with results all the details).

caption

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

...

Additional arguments (ignored).

Examples

# NOT RUN {
set.seed(123)

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

# creating caption (for null)
ggstatsplot::bf_caption_maker(
  bf.df = bf_results,
  output = "null",
  k = 3,
  caption = "Note: Iris dataset"
)

# creating caption (for alternative)
ggstatsplot::bf_caption_maker(
  bf.df = bf_results,
  output = "alternative"
)
# }

Run the code above in your browser using DataCamp Workspace