popSize {crunch}

Get and set the market size for Crunch datasets

Description

Crunch Datasets allow you to set a target population size in order to extrapolate population estimates from survey percentages. These functions let you work with the population size and magnitude.

Usage

popSize(x)

popMagnitude(x)

popSize(x) <- value

popMagnitude(x) <- value

setPopulation(x, size, magnitude)

## S4 method for signature 'CrunchDataset'
popSize(x)

## S4 replacement method for signature 'CrunchDataset'
popSize(x) <- value

## S4 method for signature 'CrunchDataset'
popMagnitude(x)

## S4 replacement method for signature 'CrunchDataset'
popMagnitude(x) <- value

## S4 method for signature 'CrunchDataset'
setPopulation(x, size, magnitude)

Arguments

x

a Crunch Dataset

value

For the setters, the size or magnitude to be set

size

the target population size, to remove a population set to NULL

magnitude

the order of magnitude with which to display the population size. Must be either 3, 6, or 9 for thousands, millions, and billions respectively.

Value

popSize and popMagnitude return the population size or magnitude. setPopulation returns the modified dataset.