This repository is for development of the USEPA R micromap package. If you would like to contribute to this repository please follow the guidelines in CONTRIBUTING.

Version 1.9.8 is the stable version on CRAN and can be installed as follows.

# install from CRAN
install.packages('micromap')
library(micromap)

The development version can be installed from the development branch on the repository.

# requires devools to install
install.packages('devtools')
library(devtools)

# install from repo
install_github('USEPA/micromap', ref = 'development')
library(micromap)

citation(package = 'micromap')

## To cite the micromap package in publications use:
## 
##   Quinn C. Payton, Michael G. McManus, Marc H. Weber, Anthony R. Olsen,
##   and Thomas M. Kincaid (2015). micromap: A Package for Linked
##   Micromaps. Journal of Statistical Software, 63(2), 1-16. URL
##   https://www.jstatsoft.org/v63/i02/.
## 
## A BibTeX entry for LaTeX users is
## 
##   @Article{,
##     title = {{micromap}: A Package for Linked Micromaps},
##     author = {Quinn Payton and Tony Olsen and Marc Weber and Michael McManus and Tom Kincaid and Marcus W. Beck},
##     journal = {Journal of Statistical Software},
##     year = {2015},
##     volume = {63},
##     number = {2},
##     pages = {1--16},
##     doi = {10.18637/jss.v063.i02},
##   }

Please consult the publication in the Journal of Statistical Software for a general overview of the package. A vignette is also provided with the development version of the package:

# view vignette
vignette(package = 'micromap')

# open vignette
vignette('Introduction_Guide')

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an “as is” basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recomendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.

By submitting a pull request, you make an agreement with EPA that you will not submit a claim of compensation for services rendered to EPA or any other federal agency. Further, you agree not to charge the time you spend developing software code related to this project to any federal grant or cooperative agreement.

This project is licensed under the GNU General Public License, GPL-2.