R/benchmark2003_hotspots.R

#' Benchmark data from 2003
#' 
#' The hotspot region indices for each benchmark
#' data set from Song and Kulldorff (2003).
#' Each data set is a vector of hotspot indices.  
#' The available data sets are
#' mixed01_hotspot, mixed02_hotspot, mixed04_hotspot, mixed08_hotspot, mixed16_hotspot,
#' rural01_hotspot, rural02_hotspot, rural04_hotspot, mixed08_hotspot, rural16_hotspot,
#' urban01_hotspot, urban02_hotspot, urban04_hotspot, urban08_hotspot, urban16_hotspot,
#' urbmix01_hotspot, urbmix02_hotspot, urbmix04_hotspot, urbmix08_hotspot, urbmix16_hotspot,
#' rurmix01_hotspot, rurmix02_hotspot, rurmix04_hotspot, rurmix08_hotspot, rurmix16_hotspot,
#' rururb01_hotspot, rururb_02_hotspot, rururb04_hotspot, rururb08_hotspot, rururb16_hotspot,
#' rurmixurb01_hotspot, rurmixurb02_hotspot, rurmixurb04_hotspot, rurmixurb08_hotspot, rurmixurb16_hotspot,
#' mixed01_6000_hotspot, mixed02_6000_hotspot, mixed04_6000_hotspot, mixed08_6000_hotspot, mixed16_6000_hotspot,
#' rural01_6000_hotspot, rural02_6000_hotspot, rural04_6000_hotspot, mixed08_6000_hotspot, rural16_6000_hotspot,
#' urban01_6000_hotspot, urban02_6000_hotspot, urban04_6000_hotspot, urban08_6000_hotspot, urban16_6000_hotspot,
#' urbmix01_6000_hotspot, urbmix02_6000_hotspot, urbmix04_6000_hotspot, urbmix08_6000_hotspot, urbmix16_6000_hotspot,
#' rurmix01_6000_hotspot, rurmix02_6000_hotspot, rurmix04_6000_hotspot, rurmix08_6000_hotspot, rurmix16_6000_hotspot,
#' rururb01_6000_hotspot, rururb02_6000_hotspot, rururb04_6000_hotspot, rururb08_6000_hotspot, rururb16_6000_hotspot,
#' rurmixurb01_6000_hotspot, rurmixurb_02_6000_hotspot, rurmixurb04_6000_hotspot, rurmixurb08_6000_hotspot, rurmixurb16_6000_hotspot.
#'
#' @name mixed01_hotspot
#' @rdname benchmark2003_hotspots
#' @docType data
#' @references Martin Kulldorff, Eric J. Feuer, Barry A.
#'   Miller, Laurence S. Freedman; Breast Cancer Clusters in
#'   the Northeast United States: A Geographic Analysis,
#'   American Journal of Epidemiology, Volume 146, Issue 2,
#'   15 July 1997, Pages 16_hotspot1-170,
#'   \url{https://doi.org/10.1093/oxfordjournals.aje.a009247}
#'   
#' Song, C., & Kulldorff, M. (2003). Power evaluation of disease clustering tests. International Journal of Health Geographics, 2, 9. http://doi.org/10.1186/1476-072X-2-9
#'
#' @format  A vector
#' @keywords data
#' @seealso neastdata
NULL

#' @name mixed02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name mixed16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

##########################
#' @name rural01_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rural16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

##########################
#' @name rurmix01_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmix16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

##########################
#' @name urban01_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urban16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

##########################
#' @name urbmix01_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name urbmix16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb01_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb02_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb04_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb08_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb16_6000_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb01_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rururb16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb01_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb02_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb04_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb08_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL

#' @name rurmixurb16_hotspot
#' @rdname benchmark2003_hotspots
#' @format NULL
#' @docType data
NULL
jpfrench81/neastbenchmark documentation built on July 26, 2023, 3:07 p.m.