svyPVpack (version 0.1-1)

svyPVcor: Survey-weighted Correlation Estimation with uasge of palusible values.

Description

svyPVcor estimates the Pearson product-moment correlation coefficient and its standard error for data from a complex survey design with plausible values.

Usage

svyPVcor(formula, design, placeholder = 1:10)

Arguments

formula

Formula, x~y for the correlation between x and y (both variables have to be part of a survey design objecct created by the survey package). For a notation description for the plausible values see in 'details'.

design

A survey design which was generated by the survey package .

placeholder

A vector of symbols, which were used for numbering of the plausible values. For a detailed description see in 'details'.

Value

The function returns a data.frame with the following columns

COR

Shows the Pearson product-moment correlation coefficient between x and y.

SE

Shows the SE for the Pearson product-moment correlation between x and y.

Number.of.cases

Shows the unweighted number of cases (NA's excluded) within each group.

Sum.of.weights

Shows the sum of weights (NA's excluded) within each group.

Details

All variables mentioned in the formula object must be part of the survey design object. Instead of the symbols, which were used for numbering the plausible values use '..' as notation (e.g. placeholder = 1:5 and PVLIT.. stands for PVLIT1, PVLIT2, PVLIT3, PVLIT4, PVLIT5).Missing values are deleted listwise.

References

Lumley, T. (2010). Complex Surveys. Hoboken, NJ: Wiley.

Saerndal, C.-E. & Swensson, B. & Wretman, J. (1992). Model Assisted Survey Sampling. New York: Springer.

Chaudhuri, A. & Stenger, H. (2005). Survey Sampling. Theory and Methods. Boka Raton, FL: Chapman & Hall/CRC.

See Also

cov.wt, svyPVeta

Examples

# data(svy_example1)