README.md

In sparrpowR: Power Analysis to Detect Spatial Relative Risk Clusters

sparrpowR: Power analysis to detect spatial relative clusters

Date repository last updated: February 01, 2023

Overview

The sparrpowR package is a suite of R functions to calculate the statistical power to detect clusters using the kernel-based spatial relative risk function that is estimated using the sparr package. Basic visualization is also supported.

Installation

To install the release version from CRAN:

install.packages("sparrpowR")

To install the development version from GitHub:

devtools::install_github("machiela-lab/sparrpowR")

Available functions

Function Description spatial_power Main function. Compute the statistical power of a spatial relative risk function using randomly generated data. spatial_data Generate random bivariate data for a spatial relative risk function. jitter_power Compute the statistical power of a spatial relative risk function using previously collected data. spatial_plots Easily make multiple plots from spatial_power, spatial_data, and jitter_power outputs. pval_correct Called within spatial_power and jitter_power, calculates various multiple testing corrections for the alpha level.

Authors

* **Ian D. Buller** - *Social & Scientific Systems, Inc., a division of DLH Corporation, Silver Spring, Maryland (current)* - *Occupational and Environmental Epidemiology Branch, Division of Cancer Epidemiology and Genetics, National Cancer Institute, National Institutes of Health, Rockville, Maryland (original)* - [GitHub](https://github.com/idblr) - [ORCID](https://orcid.org/0000-0001-9477-8582) * **Derek W. Brown** - *Integrative Tumor Epidemiology Branch, Division of Cancer Epidemiology and Genetics, National Cancer Institute, National Institutes of Health, Rockville, Maryland (original)* - [GitHub](https://github.com/derekbrown12) - [ORCID](https://orcid.org/0000-0001-8393-1713) See also the list of [contributors](https://github.com/machiela-lab/sparrpowR/graphs/contributors) who participated in this package, including: * **Tim A. Myers** - *Laboratory of Genetic Susceptibility, Division of Cancer Epidemiology and Genetics, National Cancer Institute, National Institutes of Health, Rockville, Maryland* - [GitHub](https://github.com/timyers) ## Usage wzxhzdk:0    wzxhzdk:1   wzxhzdk:2  ### Funding This package was developed while the authors were originally postdoctoral fellows supported by the [Cancer Prevention Fellowship Program](https://cpfp.cancer.gov/) at the [National Cancer Institute](https://www.cancer.gov/). Any modifications since December 05, 2022 were made while the author I.D.B. was an employee of Social & Scientific Systems, Inc., a division of [DLH Corporation](https://www.dlhcorp.com). ### Acknowledgments When citing this package for publication, please follow: citation("sparrpowR") ### Questions? Feedback? For questions about the package please contact the maintainer [Dr. Ian D. Buller](mailto:[e-mail]) or [submit a new issue](https://github.com/machiela-lab/sparrpowR/issues).

sparrpowR documentation built on Feb. 16, 2023, 5:53 p.m.