get_exposure_summary_table: Creates a summary table of exposure statistics

In eyzhao/SignIT: What the Package Does (One Line, Title Case)

Description

After running get_exposures.R, one receives an object containing the points sampled by the MCMC chains. It is often necessary to review summary statistics on these sample chains to examine the exposure ranges of individual signatures. This function provides an interface for computing summary statistics including mean, median, range, and "confidence bands".

Usage

get_exposure_summary_table(
  exposures_mcmc_output,
  alpha = c(0, 0.05, 0.5),
  fraction = FALSE
)

Arguments

exposures_mcmc_output	Output from get_exposures()
alpha	Vector defining confidence bands to report. Alpha is between 0 and 1. The two confidence limits reported are at rank alpha/2 and 1 - (alpha/2). For example, setting alpha = 0.05 results in 95 the middle 95 reporting of the 1st and 3rd quartiles. Multiple alpha values can be provided as vector elements. These values will each be computed and reported in separate columns.

Details

By default, the function reports mean and median, as well as range, 95 and quartiles.

Value

A dataframe with one row per signature and summary stats in the columns

eyzhao/SignIT documentation built on Dec. 6, 2019, 11:45 a.m.