Flag_NormalApprox

#' @description

Usage

Flag_NormalApprox(
  dfAnalyzed,
  strColumn = "Score",
  vThreshold = c(-3, -2, 2, 3),
  vFlag = c(-2, -1, 0, 1, 2),
  vFlagOrder = c(2, -2, 1, -1, 0),
  nAccrualThreshold = NULL,
  strAccrualMetric = NULL
)

Arguments

dfAnalyzed

data.frame where flags should be added.

strColumn

character Name of the column to use for thresholding. Default: "Score"

vThreshold

numeric Vector of numeric values representing threshold values. Default is c(-3,-2,2,3) which is typical for z-scores.

vFlag

numeric Vector of flag values. There must be one more item in Flag than thresholds - that is length(vThreshold)+1 == length(vFlagValues). Default is c(-2,-1,0,1,2), which is typical for z-scores.

vFlagOrder

numeric Vector of ordered flag values. Output data.frame will be sorted based on flag column using the order provided. NULL (or values that don't match vFlag) will leave the data unsorted. Must have identical values to vFlag. Default is c(2,-2,1,-1,0) which puts largest z-score outliers first in the data set.

nAccrualThreshold

numeric Specifies the minimum value required to return a score and calculate a flag. Default: NULL

strAccrualMetric

character Specifies the Metric to apply nAccrualThreshold to in order to determine the validity of a flag. Options are "Numerator", "Denominator" or "Difference". If "Difference" is specified, the threshold is based on the difference between the Denominator and the Numerator for a given Group. Default: NULL.

Details

Alias for Flag()