Usage
relrisk(dframe, response="response", stressor="stressor",
response.levels=c("Poor", "Good"), stressor.levels=c("Poor", "Good"),
wgt="wgt", xcoord="xcoord", ycoord="ycoord", stratum=NULL, cluster=NULL,
N.cluster=NULL, wgt1=NULL, xcoord1=NULL, ycoord1=NULL, popsize=NULL,
stage1size=NULL, support=NULL, swgt=NULL, swgt1=NULL, unitsize=NULL,
vartype="Local", conf=95, check.ind=TRUE)
Arguments
dframe
a data frame containing the variables required for the analysis.
If variable names are not provided in the corresponding arguments,
then variables should be named as follows:
response = the categorical response variable values
stressor = the cat
response
name of the column in dframe containing the categorical
response variable. The default is "response".
stressor
name of the column in dframe containing the categorical
stressor variable. The default is "stressor".
response.levels
category values (levels) for the categorical response
variable, where the first level is used for calculating the relative risk
estimate. If response.levels is not supplied, then values "Poor" and "Good"
are used for the first level and s
stressor.levels
category values (levels) for the categorical stressor
variable, where the first level is used for calculating the numerator of
the relative risk estimate and the second level is used for calculating
the denominator of the estimate. If st
wgt
the final adjusted weight (inverse of the sample inclusion
probability) for each site, which is either the weight for a
single-stage sample or the stage two weight for a two-stage sample.
xcoord
x-coordinate for location for each site, which is either the
x-coordinate for a single-stage sample or the stage two
x-coordinate for a two-stage sample. The default is NULL.
ycoord
y-coordinate for location for each site, which is either the
y-coordinate for a single-stage sample or the stage two
y-coordinate for a two-stage 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.
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 two-stage sample. For a stratified sample
this variable must be a vector containing a
wgt1
the final adjusted stage one weight for each site. The default
is NULL.
xcoord1
the stage one x-coordinate for location for each site. The
default is NULL.
ycoord1
the stage one y-coordinate for location for each site. The
default is NULL.
popsize
the known size of the resource - the total number of sampling
units of a finite resource or the measure of an extensive resource,
which is required for calculation of finite and continuous population
correction factors for a single-stage
stage1size
the known size of the stage one sampling units of a two-
stage sample, which is required for calculation of finite and
continuous population correction factors for a two-stage sample and
must have the names attribute set to identify the
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 pop
swgt
the size-weight for each site, which is the stage two size-weight
for a two-stage sample. The default is NULL.
swgt1
the stage one size-weight for each site. The default is NULL.
unitsize
the known sum of the size-weights of the resource, which for a
stratified sample 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.
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.