cdfStats: Descriptive statistics of the cumulative distribution...

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/cdfStats.R

Description

This function returns summary statistics of the cumulative distribution function of a continuous variable estimated with spsurvey-package.

Usage

1
cdfStats(obj, ind, all = TRUE)

Arguments

obj

Object containing the estimated cumulative distribution function of the continuous variable. The resulting object of cont.analysis() of spsurvey-package.

ind

Indicator variable. The name of the continuous variable as displayed in the resulting object of cont.analysis().

all

Summary statistics to be returned. The default option (all = TRUE) returns all summary statistics available. If all = FALSE, then only estimated population mean and standard deviation are returned. See ‘Details’.

Details

The function cont.analysis() of spsurvey-package estimates the population total, mean, variance, and standard deviation of a continuous variable. It also estimates the standard error and confidence bounds of these population estimates. In some cases it may be interesting to see all estimates, for which one uses all = TRUE. However, in other circumstances there might be interest only in taking a look at the estimated population mean and standard deviation. Then the argument all has to be set to FALSE.

Value

A data.frame containing summary statistics of the cumulative distribution function of a continuous variable.

Author(s)

Alessandro Samuel-Rosa [email protected]

References

Kincaid, T. M. and Olsen, A. R. (2013). spsurvey: Spatial Survey Design and Analysis. R package version 2.6. URL: http://www.epa.gov/nheerl/arm/.

See Also

cont.analysis.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 
if (require(spsurvey)) {
## Estimate the CDF
my.cdf <- spsurvey::cont.analysis(spsurvey.obj = my.spsurvey)

## See indicator levels in the resulting object
levels(my.cdf$Pct$Indicator)

## Return all summary statistics of indicator variable 'dx'
cdfStats(my.cdf, "dx", all = TRUE)
}

## End(Not run)

samuel-rosa/pedometrics documentation built on Feb. 11, 2020, 11:33 p.m.