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

View source: R/attrisk.analysis.R

This function organizes input and output for attributable risk analysis of categorical data generated by a probability survey.

1 2 3 4 5 | ```
attrisk.analysis(sites=NULL, subpop=NULL, design, data.ar, response.var,
stressor.var, response.levels=rep(list(c("Poor","Good")),
length(response.var)), stressor.levels=rep(list(c("Poor","Good")),
length(stressor.var)), popcorrect=FALSE, pcfsize=NULL, N.cluster=NULL,
stage1size=NULL, sizeweight=FALSE, vartype="Local", conf=95)
``` |

`sites` |
a data frame consisting of two variables: the first variable is site IDs, and the second variable is a logical vector indicating which sites to use in the analysis. The default is NULL. |

`subpop` |
a data frame describing sets of populations and subpopulations for which estimates will be calculated. The first variable is site IDs. Each subsequent variable identifies a Type of population, where the variable name is used to identify Type. A Type variable identifies each site with one of the subpopulations of that Type. The default is NULL. |

`design` |
a data frame consisting of design variables. Variables should
be named as follows: |

`data.ar` |
data frame of categorical response and stressor variables, where each variable consists of two categories. If response or stressor variables include more than two categories, occurrences of those categories must be removed or replaced with missing values. The first column of this argument is site IDs. Subsequent columns are response and stressor variables. Missing data (NA) is allowed. |

`response.var` |
character vector providing names of columns in argument data.ar that contain a response variable, where names may be repeated. Each name in this argument is matched with the corresponding value in the stressor.var argument. |

`stressor.var` |
character vector providing names of columns in argument data.ar that contain a stressor variable, where names may be repeated. Each name in this argument is matched with the corresponding value in the response.var argument. This argument must be the same length as argument response.var. |

`response.levels` |
list providing the category values (levels) for each element in the response.var argument. This argument must be the same length as argument response.var. The default is a list containing the values "Poor" and "Good" for the first and second levels, respectively, of each element in the response.var argument. |

`stressor.levels` |
list providing the category values (levels) for each element in the stressor.var argument. This argument must be the same length as argument response.var. The default is a list containing the values "Poor" and "Good" for the first and second levels, respectively, of each element in the stressor.var argument. |

`popcorrect` |
a logical value that indicates whether finite or continuous population correction factors should be employed during variance estimation, where TRUE = use the correction factor and FALSE = do not use the correction factor. The default is FALSE. To employ the correction factor for a single-stage sample, values must be supplied for argument pcfsize and for the support variable of the design argument. To employ the correction factor for a two-stage sample, values must be supplied for arguments N.cluster and stage1size, and for the support variable of the design argument. |

`pcfsize` |
size of the resource, which is required for calculation of finite and continuous population correction factors for a single-stage 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 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 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 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 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. |

`sizeweight` |
a logical value that indicates whether size-weights should be used in the analysis, where TRUE = use the size-weights and FALSE = do not use the size-weights. The default is FALSE. |

`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%. |

Value is a data frame of attributable risk estimates for all combinations of population Types, subpopulations within Types, and response variables. Standard error and confidence interval estimates also are provided.

Tom Kincaid [email protected]

Sarndal, C.E., B. Swensson, and J. Wretman. (1992). *Model Assisted
Survey Sampling*. Springer-Verlag, New York.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 | ```
mysiteID <- paste("Site", 1:100, sep="")
mysites <- data.frame(siteID=mysiteID, Active=rep(TRUE, 100))
mysubpop <- data.frame(siteID=mysiteID, All.Sites=rep("All Sites", 100),
Resource.Class=rep(c("Agr", "Forest"), c(55,45)))
mydesign <- data.frame(siteID=mysiteID, wgt=runif(100, 10, 100),
xcoord=runif(100), ycoord=runif(100), stratum=rep(c("Stratum1",
"Stratum2"), 50))
mydata.ar <- data.frame(siteID=mysiteID, RespVar1=sample(c("Poor", "Good"),
100, replace=TRUE), RespVar2=sample(c("Poor", "Good"), 100, replace=TRUE),
StressVar=sample(c("Poor", "Good"), 100, replace=TRUE), wgt=runif(100, 10,
100))
attrisk.analysis(sites=mysites, subpop=mysubpop, design=mydesign,
data.ar=mydata.ar, response.var=c("RespVar1", "RespVar2"),
stressor.var=rep("StressVar", 2))
``` |

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.