cont_analysis: Continuous variable analysis
In spsurvey: Spatial Sampling Design and Analysis
View source: R/cont_analysis.R
cont_analysis R Documentation
Continuous variable analysis
Description
This function organizes input and output for the analysis of continuous
variables. The analysis data, dframe, can be either a data frame or a
simple features (sf) object. If an sf object is used,
coordinates are extracted from the geometry column in the object, arguments
xcoord and ycoord are assigned values "xcoord" and
"ycoord", respectively, and the geometry column is dropped from the
object.
Usage
cont_analysis(
dframe,
vars,
subpops = NULL,
siteID = NULL,
weight = "weight",
xcoord = NULL,
ycoord = NULL,
stratumID = NULL,
clusterID = NULL,
weight1 = NULL,
xcoord1 = NULL,
ycoord1 = NULL,
sizeweight = FALSE,
sweight = NULL,
sweight1 = NULL,
fpc = NULL,
popsize = NULL,
vartype = "Local",
jointprob = "overton",
conf = 95,
pctval = c(5, 10, 25, 50, 75, 90, 95),
statistics = c("CDF", "Pct", "Mean", "Total"),
All_Sites = FALSE
)
Arguments
dframe
Data to be analyzed (analysis data). A data frame or
sf object containing survey design
variables, response variables, and subpopulation (domain) variables.
vars
Vector composed of character values that identify the
names of response variables in dframe.
subpops
Vector composed of character values that identify the
names of subpopulation (domain) variables in dframe.
If a value is not provided, the value "All_Sites" is assigned to the
subpops argument and a factor variable named "All_Sites" that takes
the value "All Sites" is added to the dframe data frame. The
default value is NULL.
siteID
Character value providing name of the site ID variable in
the dframe data frame. For a two-stage sample, the site ID variable
identifies stage two site IDs. The default value is NULL, which
assumes that each row in dframe represents a unique site.
weight
Character value providing name of the design weight
variable in dframe. For a two-stage sample, the
weight variable identifies stage two weights. The default value is
"weight".
xcoord
Character value providing name of the x-coordinate variable in
the dframe data frame. For a two-stage sample, the x-coordinate
variable identifies stage two x-coordinates. Note that x-coordinates are
required for calculation of the local mean variance estimator. If dframe
is an sf object, this argument is not required (as the geometry column
in dframe is used to find the x-coordinate). The default
value is NULL.
ycoord
Character value providing name of the y-coordinate variable in
the dframe data frame. For a two-stage sample, the y-coordinate
variable identifies stage two y-coordinates. Note that y-coordinates are
required for calculation of the local mean variance estimator. If dframe
is an sf object, this argument is not required (as the geometry column
in dframe is used to find the y-coordinate). The default
value is NULL.
stratumID
Character value providing name of the stratum ID variable in
the dframe data frame. The default value is NULL.
clusterID
Character value providing the name of the cluster
(stage one) ID variable in dframe. Note that cluster
IDs are required for a two-stage sample. The default value is NULL.
weight1
Character value providing name of the stage one weight
variable in dframe. The default value is NULL.
xcoord1
Character value providing the name of the stage one
x-coordinate variable in dframe. Note that x
coordinates are required for calculation of the local mean variance
estimator. The default value is NULL.
ycoord1
Character value providing the name of the stage one
y-coordinate variable in dframe. Note that
y-coordinates are required for calculation of the local mean variance
estimator. The default value is NULL.
sizeweight
Logical value that indicates whether size weights should be
used during estimation, where TRUE uses size weights and
FALSE does not use size weights. To employ size weights for a
single-stage sample, a value must be supplied for argument weight. To
employ size weights for a two-stage sample, values must be supplied for
arguments weight and weight1. The default value is FALSE.
sweight
Character value providing the name of the size weight variable
in dframe. For a two-stage sample, the size weight
variable identifies stage two size weights. The default value is
NULL.
sweight1
Character value providing name of the stage one size weight
variable in dframe. The default value is NULL.
fpc
Object that specifies values required for calculation of the
finite population correction factor used during variance estimation. The
object must match the survey design in terms of stratification and whether
the design is single-stage or two-stage. For an unstratified design, the
object is a vector. The vector is composed of a single numeric value for a
single-stage design. For a two-stage unstratified design, the object is a
named vector containing one more than the number of clusters in the sample,
where the first item in the vector specifies the number of clusters in the
population and each subsequent item specifies the number of stage two units
for the cluster. The name for the first item in the vector is arbitrary.
Subsequent names in the vector identify clusters and must match the cluster
IDs. For a stratified design, the object is a named list of vectors, where
names must match the strata IDs. For each stratum, the format of the
vector is identical to the format described for unstratified single-stage
and two-stage designs. Note that the finite population correction factor
is not used with the local mean variance estimator.
Example fpc for a single-stage unstratified survey design:
fpc <- 15000
Example fpc for a single-stage stratified survey design:
fpc <- list(
Stratum_1 = 9000,
Stratum_2 = 6000)
Example fpc for a two-stage unstratified survey design:
fpc <- c(
Ncluster = 150,
Cluster_1 = 150,
Cluster_2 = 75,
Cluster_3 = 75,
Cluster_4 = 125,
Cluster_5 = 75)
Example fpc for a two-stage stratified survey design:
fpc <- list(
Stratum_1 = c(
Ncluster_1 = 100,
Cluster_1 = 125,
Cluster_2 = 100,
Cluster_3 = 100,
Cluster_4 = 125,
Cluster_5 = 50),
Stratum_2 = c(
Ncluster_2 = 50,
Cluster_1 = 75,
Cluster_2 = 150,
Cluster_3 = 75,
Cluster_4 = 75,
Cluster_5 = 125))
popsize
Object that provides values for the population argument of the
calibrate or postStratify functions in the survey package. If
a value is provided for popsize, then either the calibrate or
postStratify function is used to modify the survey design object
that is required by functions in the survey package. Whether to use the
calibrate or postStratify function is dictated by the format
of popsize, which is discussed below. Post-stratification adjusts the
sampling and replicate weights so that the joint distribution of a set of
post-stratifying variables matches the known population joint distribution.
Calibration, generalized raking, or GREG estimators generalize
post-stratification and raking by calibrating a sample to the marginal
totals of variables in a linear regression model. For the calibrate
function, the object is a named list, where the names identify factor
variables in dframe. Each element of the list is a
named vector containing the population total for each level of the
associated factor variable. For the postStratify function, the
object is either a data frame, table, or xtabs object that provides the
population total for all combinations of selected factor variables in the
dframe data frame. If a data frame is used for popsize, the
variable containing population totals must be the last variable in the data
frame. If a table is used for popsize, the table must have named
dimnames where the names identify factor variables in the
dframe data frame. If the popsize argument is equal to NULL,
then neither calibration nor post-stratification is performed. The default
value is NULL.
Example popsize for calibration:
popsize <- list(
Ecoregion = c(
East = 750,
Central = 500,
West = 250),
Type = c(
Streams = 1150,
Rivers = 350))
Example popsize for post-stratification using a data frame:
popsize <- data.frame(
Ecoregion = rep(c("East", "Central", "West"),
rep(2, 3)),
Type = rep(c("Streams", "Rivers"), 3),
Total = c(575, 175, 400, 100, 175, 75))
Example popsize for post-stratification using a table:
popsize <- with(MySurveyFrame,
table(Ecoregion, Type))
Example popsize for post-stratification using an xtabs object:
popsize <- xtabs(~Ecoregion + Type,
data = MySurveyFrame)
vartype
Character value providing the choice of the variance
estimator, where "Local" indicates the local mean estimator,
"SRS" indicates the simple random sampling estimator, "HT"
indicates the Horvitz-Thompson estimator, and "YG" indicates the
Yates-Grundy estimator. The default value is "Local".
jointprob
Character value providing the choice of joint inclusion
probability approximation for use with Horvitz-Thompson and Yates-Grundy
variance estimators, where "overton" indicates the Overton
approximation, "hr" indicates the Hartley-Rao approximation, and
"brewer" equals the Brewer approximation. The default value is
"overton".
conf
Numeric value providing the Gaussian-based confidence level. The default value
is 95.
pctval
Vector of the set of values at which percentiles are
estimated. The default set is: c(5, 10, 25, 50, 75, 90, 95).
statistics
Character vector specifying desired estimates, where
"CDF" specifies CDF estimates, "Pct" specifies percentile
estimates, "Mean" specifies mean estimates, and "Total" specifies
total estimates. Any combination of the four choices may be provided by
the user. The default value is c("CDF", "Pct", "Mean", "Total").
All_Sites
A logical variable used when subpops is not
NULL. If All_Sites is TRUE, then alongside the
subpopulation output, output for all sites (ignoring subpopulations) is
returned for each variable in vars. If All_Sites is
FALSE, then alongside the subpopulation output, output for all sites
(ignoring subpopulations) is not returned for each variable in vars.
The default is FALSE.
Value
The analysis results. A list composed of one, two, three, or four
data frames that contain population estimates for all combinations of
subpopulations, categories within each subpopulation, and response
variables, where the number of data frames is determined by argument
statistics. The possible data frames in the output list are:
CDF: a data frame containing CDF estimates
Pct: data frame containing percentile estimates
Mean: a data frame containing mean estimates
Total: a data frame containing total estimates
The CDF data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- Value
value of response variable
- nResp
sample size at or below Value
- Estimate.P
CDF proportion estimate (in %)
- StdError.P
standard error of CDF proportion estimate
- MarginofError.P
margin of error of CDF proportion estimate
- LCBxxPct.P
xx% (default 95%) lower confidence bound of CDF proportion estimate
- UCBxxPct.P
xx% (default 95%) upper confidence bound of CDF proportion estimate
- Estimate.U
CDF total estimate
- StdError.U
standard error of CDF total estimate
- MarginofError.U
margin of error of CDF total estimate
- LCBxxPct.U
xx% (default 95%) lower confidence bound of CDF total estimate
- UCBxxPct.U
xx% (default 95%) upper confidence bound of CDF total estimate
The Pct data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- Statistic
value of percentile
- nResp
sample size at or below Value
- Estimate
percentile estimate
- StdError
standard error of percentile estimate
- MarginofError
margin of error of percentile estimate
- LCBxxPct
xx% (default 95%) lower confidence bound of percentile estimate
- UCBxxPct
xx% (default 95%) upper confidence bound of percentile estimate
The Mean data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- nResp
sample size at or below Value
- Estimate
mean estimate
- StdError
standard error of mean estimate
- MarginofError
margin of error of mean estimate
- LCBxxPct
xx% (default 95%) lower confidence bound of mean estimate
- UCBxxPct
xx% (default 95%) upper confidence bound of mean estimate
The Total data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- nResp
sample size at or below Value
- Estimate
total estimate
- StdError
standard error of total estimate
- MarginofError
margin of error of total estimate
- LCBxxPct
xx% (default 95%) lower confidence bound of total estimate
- UCBxxPct
xx% (default 95%) upper confidence bound of total estimate
Author(s)
Tom Kincaid Kincaid.Tom@epa.gov
See Also
cat_analysis for categorical variable analysis
Examples
dframe <- data.frame(
siteID = paste0("Site", 1:100),
wgt = runif(100, 10, 100),
xcoord = runif(100),
ycoord = runif(100),
stratum = rep(c("Stratum1", "Stratum2"), 50),
ContVar = rnorm(100, 10, 1),
All_Sites = rep("All Sites", 100),
Resource_Class = rep(c("Good", "Poor"), c(55, 45))
)
myvars <- c("ContVar")
mysubpops <- c("All_Sites", "Resource_Class")
mypopsize <- data.frame(
Resource_Class = c("Good", "Poor"),
Total = c(4000, 1500)
)
cont_analysis(dframe,
vars = myvars, subpops = mysubpops, siteID = "siteID",
weight = "wgt", xcoord = "xcoord", ycoord = "ycoord",
stratumID = "stratum", popsize = mypopsize, statistics = "Mean"
)
spsurvey documentation built on May 31, 2023, 6:25 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/cont_analysis.R
| cont_analysis | R Documentation |
Continuous variable analysis
Description
This function organizes input and output for the analysis of continuous
variables. The analysis data, dframe, can be either a data frame or a
simple features (sf) object. If an sf object is used,
coordinates are extracted from the geometry column in the object, arguments
xcoord and ycoord are assigned values "xcoord" and
"ycoord", respectively, and the geometry column is dropped from the
object.
Usage
cont_analysis(
dframe,
vars,
subpops = NULL,
siteID = NULL,
weight = "weight",
xcoord = NULL,
ycoord = NULL,
stratumID = NULL,
clusterID = NULL,
weight1 = NULL,
xcoord1 = NULL,
ycoord1 = NULL,
sizeweight = FALSE,
sweight = NULL,
sweight1 = NULL,
fpc = NULL,
popsize = NULL,
vartype = "Local",
jointprob = "overton",
conf = 95,
pctval = c(5, 10, 25, 50, 75, 90, 95),
statistics = c("CDF", "Pct", "Mean", "Total"),
All_Sites = FALSE
)
Arguments
dframe |
Data to be analyzed (analysis data). A data frame or
|
vars |
Vector composed of character values that identify the
names of response variables in |
subpops |
Vector composed of character values that identify the
names of subpopulation (domain) variables in |
siteID |
Character value providing name of the site ID variable in
the |
weight |
Character value providing name of the design weight
variable in |
xcoord |
Character value providing name of the x-coordinate variable in
the |
ycoord |
Character value providing name of the y-coordinate variable in
the |
stratumID |
Character value providing name of the stratum ID variable in
the |
clusterID |
Character value providing the name of the cluster
(stage one) ID variable in |
weight1 |
Character value providing name of the stage one weight
variable in |
xcoord1 |
Character value providing the name of the stage one
x-coordinate variable in |
ycoord1 |
Character value providing the name of the stage one
y-coordinate variable in |
sizeweight |
Logical value that indicates whether size weights should be
used during estimation, where |
sweight |
Character value providing the name of the size weight variable
in |
sweight1 |
Character value providing name of the stage one size weight
variable in |
fpc |
Object that specifies values required for calculation of the finite population correction factor used during variance estimation. The object must match the survey design in terms of stratification and whether the design is single-stage or two-stage. For an unstratified design, the object is a vector. The vector is composed of a single numeric value for a single-stage design. For a two-stage unstratified design, the object is a named vector containing one more than the number of clusters in the sample, where the first item in the vector specifies the number of clusters in the population and each subsequent item specifies the number of stage two units for the cluster. The name for the first item in the vector is arbitrary. Subsequent names in the vector identify clusters and must match the cluster IDs. For a stratified design, the object is a named list of vectors, where names must match the strata IDs. For each stratum, the format of the vector is identical to the format described for unstratified single-stage and two-stage designs. Note that the finite population correction factor is not used with the local mean variance estimator. Example fpc for a single-stage unstratified survey design:
Example fpc for a single-stage stratified survey design:
Example fpc for a two-stage unstratified survey design:
Example fpc for a two-stage stratified survey design:
|
popsize |
Object that provides values for the population argument of the
Example popsize for calibration:
Example popsize for post-stratification using a data frame:
Example popsize for post-stratification using a table:
Example popsize for post-stratification using an xtabs object:
|
vartype |
Character value providing the choice of the variance
estimator, where |
jointprob |
Character value providing the choice of joint inclusion
probability approximation for use with Horvitz-Thompson and Yates-Grundy
variance estimators, where |
conf |
Numeric value providing the Gaussian-based confidence level. The default value
is |
pctval |
Vector of the set of values at which percentiles are
estimated. The default set is: |
statistics |
Character vector specifying desired estimates, where
|
All_Sites |
A logical variable used when |
Value
The analysis results. A list composed of one, two, three, or four
data frames that contain population estimates for all combinations of
subpopulations, categories within each subpopulation, and response
variables, where the number of data frames is determined by argument
statistics. The possible data frames in the output list are:
CDF: a data frame containing CDF estimates
Pct: data frame containing percentile estimates
Mean: a data frame containing mean estimates
Total: a data frame containing total estimates
The CDF data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- Value
value of response variable
- nResp
sample size at or below
Value- Estimate.P
CDF proportion estimate (in %)
- StdError.P
standard error of CDF proportion estimate
- MarginofError.P
margin of error of CDF proportion estimate
- LCBxxPct.P
xx% (default 95%) lower confidence bound of CDF proportion estimate
- UCBxxPct.P
xx% (default 95%) upper confidence bound of CDF proportion estimate
- Estimate.U
CDF total estimate
- StdError.U
standard error of CDF total estimate
- MarginofError.U
margin of error of CDF total estimate
- LCBxxPct.U
xx% (default 95%) lower confidence bound of CDF total estimate
- UCBxxPct.U
xx% (default 95%) upper confidence bound of CDF total estimate
The Pct data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- Statistic
value of percentile
- nResp
sample size at or below
Value- Estimate
percentile estimate
- StdError
standard error of percentile estimate
- MarginofError
margin of error of percentile estimate
- LCBxxPct
xx% (default 95%) lower confidence bound of percentile estimate
- UCBxxPct
xx% (default 95%) upper confidence bound of percentile estimate
The Mean data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- nResp
sample size at or below
Value- Estimate
mean estimate
- StdError
standard error of mean estimate
- MarginofError
margin of error of mean estimate
- LCBxxPct
xx% (default 95%) lower confidence bound of mean estimate
- UCBxxPct
xx% (default 95%) upper confidence bound of mean estimate
The Total data frame contains the following variables:
- Type
subpopulation (domain) name
- Subpopulation
subpopulation name within a domain
- Indicator
response variable
- nResp
sample size at or below
Value- Estimate
total estimate
- StdError
standard error of total estimate
- MarginofError
margin of error of total estimate
- LCBxxPct
xx% (default 95%) lower confidence bound of total estimate
- UCBxxPct
xx% (default 95%) upper confidence bound of total estimate
Author(s)
Tom Kincaid Kincaid.Tom@epa.gov
See Also
cat_analysisfor categorical variable analysis
Examples
dframe <- data.frame(
siteID = paste0("Site", 1:100),
wgt = runif(100, 10, 100),
xcoord = runif(100),
ycoord = runif(100),
stratum = rep(c("Stratum1", "Stratum2"), 50),
ContVar = rnorm(100, 10, 1),
All_Sites = rep("All Sites", 100),
Resource_Class = rep(c("Good", "Poor"), c(55, 45))
)
myvars <- c("ContVar")
mysubpops <- c("All_Sites", "Resource_Class")
mypopsize <- data.frame(
Resource_Class = c("Good", "Poor"),
Total = c(4000, 1500)
)
cont_analysis(dframe,
vars = myvars, subpops = mysubpops, siteID = "siteID",
weight = "wgt", xcoord = "xcoord", ycoord = "ycoord",
stratumID = "stratum", popsize = mypopsize, statistics = "Mean"
)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.