baymedr (version 0.1.1)

get_bf: Extract Bayes factor from S4 object

Description

get_bf extracts the Bayes factor from an S4 object (i.e., '>baymedrSuperiority, '>baymedrEquivalence, '>baymedrNonInferiority), created from the functions super_bf, equiv_bf, or infer_bf.

Usage

get_bf(object)

Arguments

object

An S4 object of class '>baymedrSuperiority, '>baymedrEquivalence, or '>baymedrNonInferiority.

Value

A numeric scalar, providing the Bayes factor from an S4 object.

Examples

# NOT RUN {
# Extract Bayes factor from a baymedrSuperiority object using raw data:
mod_super <- super_bf(x = rnorm(100, 10, 15),
                      y = rnorm(130, 13, 10))

get_bf(object = mod_super)

# Extract Bayes factor from a baymedrEquivalence object using raw data:
mod_equiv <- equiv_bf(x = rnorm(100, 10, 15),
                      y = rnorm(130, 13, 10))

get_bf(object = mod_equiv)

# Extract Bayes factor from a baymedrNonInferiority object using raw data:
mod_infer <- infer_bf(x = rnorm(100, 10, 15),
                      y = rnorm(130, 13, 10),
                      ni_margin = 1)

get_bf(object = mod_infer)
# }