pval_star: pval_star function

View source: R/format.R

pval_starR Documentation

pval_star function

Description

takes a vector of pvalues and values and adds star demarcation depending on the p values given

Usage

pval_star(
  pvals,
  starmat,
  vec_return = FALSE,
  correction = "none",
  digs = "none"
)

Arguments

pvals

a vector of p values used to determine the demarcation to apply

starmat

a vector of values to which demarcation (e.g. '*') will be applied. if this is not supplied then the demarcation will be applied to the pvalues supplied in pvals

vec_return

boolean indcating whether to return a vector instaed of a data frame. default is FALSE

correction

switch indicating whether a p.value correction for multiple comparisons should be applied. this uses stats::p.adjust and takes any of those types. default is 'none'

digs

the number of digits to round the values to. default is 'none' indicating no rounding

Examples

pval_star_function()


clmacleod/highlandr documentation built on Oct. 11, 2023, 8:04 p.m.