Category Proportion and Size Estimates
Description
This function estimates proportion (expressed as percent) and size of a resource in each of a set of categories and can also be used to estimate proportion and size for site status categories. Upper and lower confidence bounds also are estimated.
Usage
1 2 3 4 5  category.est(catvar, wgt, x=NULL, y=NULL, stratum=NULL, cluster=NULL, wgt1=NULL,
x1=NULL, y1=NULL, popsize=NULL, popcorrect=FALSE, pcfsize=NULL,
N.cluster=NULL, stage1size=NULL, support=NULL, sizeweight=FALSE, swgt=NULL,
swgt1=NULL, vartype="Local", conf=95, check.ind=TRUE, warn.ind=NULL,
warn.df=NULL, warn.vec=NULL)

Arguments
catvar 
the value of the categorical response variable or the site status for each site. 
wgt 
the final adjusted weight (inverse of the sample inclusion probability) for each site, which is either the weight for a singlestage sample or the stage two weight for a twostage sample. 
x 
xcoordinate for location for each site, which is either the xcoordinate for a singlestage sample or the stage two xcoordinate for a twostage sample. The default is NULL. 
y 
ycoordinate for location for each site, which is either the ycoordinate for a singlestage sample or the stage two ycoordinate for a twostage sample. The default is NULL. 
stratum 
the stratum for each site. The default is NULL. 
cluster 
the stage one sampling unit (primary sampling unit or cluster) code for each site. The default is NULL. 
wgt1 
the final adjusted stage one weight for each site. The default is NULL. 
x1 
the stage one xcoordinate for location for each site. The default is NULL. 
y1 
the stage one ycoordinate for location for each site. The default is NULL. 
popsize 
known size of the resource, which is used to perform ratio adjustment to estimators expressed using measurement units for the resource and to calculate strata proportions for calculating estimates for a stratified sample. For a finite resource, this argument is either the total number of sampling units or the known sum of sizeweights. For an extensive resource, this argument is the measure of the resource, i.e., either known total length for a linear resource or known total area for an areal resource. For a stratified sample this variable must be a vector containing a value for each stratum and must have the names attribute set to identify the stratum codes. The default is NULL. 
popcorrect 
a logical value that indicates whether finite or continuous population correction factors should be employed during variance estimation, where TRUE = use the correction factors and FALSE = do not use the correction factors. The default is FALSE. To employ the correction factor for a singlestage sample, values must be supplied for arguments pcfsize and support. To employ the correction factor for a twostage sample, values must be supplied for arguments N.cluster, stage1size, and support. 
pcfsize 
size of the resource, which is required for calculation of finite and continuous population correction factors for a singlestage sample. For a stratified sample this argument must be a vector containing a value for each stratum and must have the names attribute set to identify the stratum codes. The default is NULLL. 
N.cluster 
the number of stage one sampling units in the resource, which is required for calculation of finite and continuous population correction factors for a twostage sample. For a stratified sample this variable must be a vector containing a value for each stratum and must have the names attribute set to identify the stratum codes. The default is NULL. 
stage1size 
size of the stage one sampling units of a twostage sample, which is required for calculation of finite and continuous population correction factors for a twostage sample and must have the names attribute set to identify the stage one sampling unit codes. For a stratified sample, the names attribute must be set to identify both stratum codes and stage one sampling unit codes using a convention where the two codes are separated by the & symbol, e.g., "Stratum 1&Cluster 1". The default is NULL. 
support 
the support value for each site  the value one (1) for a site from a finite resource or the measure of the sampling unit associated with a site from an extensive resource, which is required for calculation of finite and continuous population correction factors. The default is NULL. 
sizeweight 
a logical value that indicates whether sizeweights should be used in the analysis, where TRUE = use the sizeweights and FALSE = do not use the sizeweights. The default is FALSE. 
swgt 
the sizeweight for each site, which is the stage two sizeweight for a twostage sample. The default is NULL. 
swgt1 
the stage one sizeweight for each site. The default is NULL. 
vartype 
the choice of variance estimator, where "Local" = local mean estimator and "SRS" = SRS estimator. The default is "Local". 
conf 
the confidence level. The default is 95%. 
check.ind 
a logical value that indicates whether compatability checking of the input values is conducted, where TRUE = conduct compatibility checking and FALSE = do not conduct compatibility checking. The default is TRUE. 
warn.ind 
a logical value that indicates whether warning messages were generated, where TRUE = warning messages were generated and FALSE = warning messages were not generated. The default is NULL. 
warn.df 
a data frame for storing warning messages. The default is NULL. 
warn.vec 
a vector that contains names of the population type, the subpopulation, and an indicator. The default is NULL. 
Details
Proportion estimates are calculated using the HorvitzThompson ratio estimator, i.e., the ratio of two HorvitzThompson estimators. The numerator of the ratio estimates the size of the category. The denominator of the ratio estimates the size of the resource. Variance estimates for the proportion estimates are calculated using either the local mean variance estimator or the simple random sampling (SRS) variance estimator. The choice of variance estimator is subject to user control. The local mean variance estimator requires the xcoordinate and the ycoordinate of each site. The SRS variance estimator uses the independent random sample approximation to calculate joint inclusion probabilities. Confidence bounds are calculated using a Normal distribution multiplier. For a finite resource size is the number of units in the resource. For an extensive resource size is the measure (extent) of the resource, i.e., length, area, or volume. Size estimates are calculated using the Horvitz Thompson estimator. Variance estimates for the size estimates are calculated using either the local mean variance estimator or the SRS variance estimator. The function can accommodate a stratified sample. For a stratified sample, separate estimates and standard errors are calculated for each stratum, which are used to produce estimates and standard errors for all strata combined. Strata that contain a single value are removed. For a stratified sample, when either the size of the resource or the sum of the sizeweights for the resource is provided for each stratum, those values are used as stratum weights for calculating the estimates and standard errors for all strata combined. In addition, when either of those known values is provided for each stratum, size estimates are obtained by multiplying the proportion estimate, i.e., the HorvitzThompson ratio estimator, by the known value for the stratum. For a stratified sample when neither the size of the resource nor the sum of the sizeweights of the resource is provided for each stratum, estimated values are used as stratum weights for calculating the estimates and standard errors for all strata combined. The function can accommodate singlestage and twostage samples for both stratified and unstratified sampling designs. Finite population and continuous population correction factors can be utilized in variance estimation. The function checks for compatibility of input values and removes missing values.
Value
If the function was called by the cat.analysis function, then value is a list containing the following components:

Results
 a data frame containing estimates and confidence bounds 
warn.ind
 a logical value indicating whether warning messages were generated 
warn.df
 a data frame containing warning messages
If the function was called directly, then value is a data frame containing estimates and confidence bounds.
Author(s)
Tom Kincaid Kincaid.Tom@epa.gov
References
DiazRamos, S., D.L. Stevens, Jr., and A.R. Olsen. (1996). EMAP Statistical Methods Manual. EPA/620/R96/XXX. Corvallis, OR: U.S. Environmental Protection Agency, Office of Research and Development, National Health Effects and Environmental Research Laboratory, Western Ecology Division.
Examples
1 2 3 4 5 6 7  catvar < rep(c("north", "south", "east", "west"), rep(25, 4))
wgt < runif(100, 10, 100)
category.est(catvar, wgt, vartype="SRS")
x < runif(100)
y < runif(100)
category.est(catvar, wgt, x, y)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker. Vote for new features on Trello.