calcSummaryOutputValues: Internal/private method. Compute bounds and summary...

Description Usage Arguments Value Examples

Description

calcSummaryOutputValues() is an internal/private helper method for calculating the bounds. Called by generateBounds().

Usage

1
2
calcSummaryOutputValues(x, t, n, trueBetaB = NULL,
  useXRangeOffset = TRUE, returnAdditionalStats = FALSE)

Arguments

x

Numeric (double-precision) vector. Contains the proportion of variable X in each precinct (or analagous geographic unit)

t

Numeric (double-precision) vector. Contains the proportion of variable T in each precinct (or analagous geographic unit)

n

Numeric (double-precision) vector. Contains the number of elements (people/households/etc.) in each precinct (or analagous geographic unit)

trueBetaB

Numeric (double-precision) vector. Contains the true conditional values (beta_i) in each precinct (or analagous geographic unit). Optional. Default NULL.

useXRangeOffset

boolean If True, an offset of 0.00001 is applied to l and u to avoid division by 0 in subsequent calculations. Default TRUE

returnAdditionalStats

boolean If True, additional summary statistics are generated. Default FALSE.

Value

List object with the bounds and summary statistics

Examples

1
2
3
4
## Not run: 
outputList <- calcSummaryOutputValues(x, t, n, NULL, TRUE, FALSE)

## End(Not run)

eiPartialID documentation built on May 2, 2019, 4:18 a.m.