Merge pull request #32 from mps9506/paper

Paper

.Rbuildignore

@@ -11,3 +11,4 @@
 ^pkgdown*$
 ^docs$
 ^\.lintr$
+^paper$

CONDUCT.md

@@ -0,0 +1,35 @@
+## Contributer Code of Conduct
+
+This Code of Conduct is adapted[io.js CoC](https://github.com/nodejs/node/blob/v1.x/CONTRIBUTING.md#code-of-conduct), adapted from[Rust's CoC](http://www.rust-lang.org/conduct.html).
+
+* We are committed to providing a friendly, safe and welcoming
+  environment for all, regardless of gender, sexual orientation,
+  disability, ethnicity, religion, or similar personal characteristic.
+* Please avoid using overtly sexual nicknames or other nicknames that
+  might detract from a friendly, safe and welcoming environment for
+  all.
+* Please be kind and courteous. There's no need to be mean or rude.
+* Respect that people have differences of opinion and that every
+  design or implementation choice carries a trade-off and numerous
+  costs. There is seldom a right answer.
+* Please keep unstructured critique to a minimum. If you have solid
+  ideas you want to experiment with, make a fork and see how it works.
+* We will exclude you from interaction if you insult, demean or harass
+  anyone.  That is not welcome behaviour. We interpret the term
+  "harassment" as including the definition in the [Citizen Code of
+  Conduct](http://citizencodeofconduct.org/); if you have any lack of
+  clarity about what might be included in that concept, please read
+  their definition. In particular, we don't tolerate behavior that
+  excludes people in socially marginalized groups.
+* Private harassment is also unacceptable. No matter who you are, if
+  you feel you have been or are being harassed or made uncomfortable
+  by a community member, please contact one of the channel ops or any
+  of the TC members immediately with a capture (log, photo, email) of
+  the harassment if possible.  Whether you're a regular contributor or
+  a newcomer, we care about making this community a safe place for you
+  and we've got your back.
+* Likewise any spamming, trolling, flaming, baiting or other
+  attention-stealing behaviour is not welcome.
+* Avoid the use of personal pronouns in code comments or
+  documentation. There is no need to address persons when explaining
+  code (e.g. "When the developer")

paper/paper.bib

@@ -0,0 +1,23 @@
+@misc{us_environmental_protection_agency_enforcement_2018,
+	title = {Enforcement and {Compliance} {History} {Online}},
+	url = {https://echo.epa.gov/},
+	author = {{US Environmental Protection Agency}},
+	year = {2018}
+}
+
+@article{sandve_ten_2013,
+	title = {Ten {Simple} {Rules} for {Reproducible} {Computational} {Research}},
+	volume = {9},
+	issn = {1553-7358},
+	url = {http://dx.plos.org/10.1371/journal.pcbi.1003285},
+	doi = {10.1371/journal.pcbi.1003285},
+	language = {en},
+	number = {10},
+	urldate = {2018-06-26},
+	journal = {PLoS Computational Biology},
+	author = {Sandve, Geir Kjetil and Nekrutenko, Anton and Taylor, James and Hovig, Eivind},
+	editor = {Bourne, Philip E.},
+	month = oct,
+	year = {2013},
+	pages = {e1003285}
+}

paper/paper.md

@@ -0,0 +1,27 @@
+---
+title: `echor: An R package to obtain environmental compliance and enforcement data`
+tags:
+  - R
+  - API
+  - environmental data
+  - Environmental Protection Agency
+authors:
+  - name: Michael P. Schramm
+    orcid: 0000-0003-1876-6592
+    affiliation: 1
+affiliations:
+  - index: 1
+    name: Texas Water Resources Institute, Texas A&M University, College Station, Texas.
+date:
+bibliography: paper.bib
+---
+
+# Summary
+
+The United States Environmental Protection Agency (EPA) regulates the discharge and emission of pollutants into waterbodies and air. The owners and operators of facilities apply for permits through the EPA or deligated state authorities, who determine the appropriate disharge limits, and monitoring and reporting requirements. Information about these permitted and mandated discharge reports are publically available through EPA's Environmental Compliance and History Online (ECHO) website [@us_environmental_protection_agency_enforcement_2018].
+
+ECHO provides a web interface to explore facility data and environmental compliance for permitted drinking water plants, facilities permitted to discharge into water bodies, and facilities with air emissions permits. ECHO also provides a web interface to generate discharge and emissions reports based on self reported data from permitted facilities. The point and click nature of the ECHO website is tedious, error-prone, and may not be fully reproducible when generating even moderate sized datasets. Implementing a script to query and automate data retieval is the first step to implementing reproducible research [@sandve_ten_2013]. 
+
+The echor package utilizes ECHO's REST services to query the ECHO database, download the generated data, and transform the data into a tidy dataframe or simple feature dataframe with a single function. Additional functions are provided to obtain metadata and lookup pollutant parameter codes used by EPA. The package streamlines workflows and introduces reproducible data retrieval steps for two use cases. First, agencies and contractors that routinely use wastewater discharge volume and pollutant concentrations to develop total maximum daily loads for impaired waterbodies. Second, academic researchers that use permit and pollutant data for water quality assessments, water quality models, public health assessments, trend analysis, environmental justice research, and more. The software and usage examples are currently available on GitHub (https://github.com/mps9506/echor) and CRAN (https://cran.r-project.org/package=echor).
+
+# References