check_pic_stat: Internal function to check test statistics

View source: R/summary-stats.R

check_pic_statR Documentation

Internal function to check test statistics

Description

Makes sure test statistics sent to calculate_pic_stat are in the correct format

Usage

check_pic_stat(stats)

Arguments

stats

a named list of test statistics

Value

named list of test statistics after being checked.

See Also

calculate_pic_stat

Examples

## produce list of test stats (using default test statistics)
check_pic_stat(default_pic_stat())

## use custom list of test statistics
foo <- function(x) mean(x$pics[,"contrasts"])

my.stats <- list(mean.of.contrasts=foo)
check_pic_stat(my.stats)

mwpennell/arbutus documentation built on Oct. 6, 2022, 10 a.m.