convertMeanShiftToOverlap: Function that converts a mean shift of one distribution (in...

In ccpluncw/ccpl_R_RRW: What the Package Does (One Line, Title Case)

Function that converts a mean shift of one distribution (in SD units) to an overlap

Description

This function converts a mean shift of one distribution (in SD units) to an overlap. To do so, it uses an equation fit to normal distribution changes - which will fit the average distibution shape (if not all individual distributions)

Usage

convertMeanShiftToOverlap(
  currentOverlap,
  meanShiftInSDunits,
  allowExactZeroToShift = T
)

Arguments

currentOverlap	A number that is the current overlap of the two distributions before the mean shift.
meanShiftInSDunits	A number that is the mean shift of one distribution shift SD units.
allowExactZeroToShift	A boolean that specifies whether to allow an exact zero overlap to shift. You may want to set this to FALSE if you beleive that an overlap of Zero indicated distributions that are so far appart that any mean shift if unlikely to change that overlap. When it is set to TRUE, the overlap of Zero is set to 0.0001 (allowing a shift to occur). This only applies to "exact zeros." When this function reduces an overlap to Zero, that reduction size is known and will not require a correction. DEFAULT = TRUE.

Value

A number that represents the new overlap after the mean shift is taken into account

Examples

convertMeanShiftToOverlap (0.5, 1)

ccpluncw/ccpl_R_RRW documentation built on July 4, 2025, 3:24 p.m.