get_or: Summarises Odds Ratio statistic Returns odds ratio values for...

Description Usage Arguments Value Examples

View source: R/odds_ratio.R

Description

Summarises Odds Ratio statistic Returns odds ratio values for actual dataset and posterior predictions. Summarises the median and HDI of their difference and returns the ppp-value.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
get_or(
  model,
  n_samples = NULL,
  ci_width = 0.89,
  zero_correction = "none",
  ci_method = "Woolf",
  nsim_ci = 1e+07,
  nsim_median = 1e+05,
  cores = 4
)

Arguments

model

birtmsfit

n_samples

int - Number of posterior samples to use

ci_width

double

zero_correction

character; 'none', 'Haldane', 'compromise' or 'Bayes'

ci_method

character; 'Woolf', 'unconditional', 'compromise', 'BayesEqTails' or 'BayesHDI'

nsim_ci

integer; number of draws used to get a distribution of the odds ratio value to calculate CIs

nsim_median

integer; number of draws used to get a distribution of the odds ratio value to calculate the median

cores

#' @param cores int; number of CPU cores used for parallel processing

Value

birtmsdata; tibble with additinal attributes

Examples

1
2
3
4
## Not run: 
get_or(fit, n_samples = 500)

## End(Not run)

Famondir/birtms documentation built on Feb. 18, 2022, 2:51 a.m.