Skip to content

Commit

Permalink
add references to pyaqsapi
Browse files Browse the repository at this point in the history
  • Loading branch information
mccroweyclinton-EPA committed Dec 1, 2023
1 parent 50a1ed0 commit 2f4c016
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 21 deletions.
18 changes: 10 additions & 8 deletions MD5
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
d3a7f7cc6aca27a043309d5bf9f32edc *codemeta.json
a4f38bdcd1e2b228600cb6e693648a12 *cran-comments.md
a4f38bdcd1e2b228600cb6e693648a12 *cran-comments.Rmd
8fe7ddfb9b852c041024d63250b69e7d *DESCRIPTION
7b3092d9d1ec246090f159fd55deeb57 *DESCRIPTION
1dc95961c4c280f8645a65d15662725f *dev/contributing.md
4fc13def6ec5d889261f1f22a13ba542 *dev/contributing.Rmd
74e297a0dc0b508ed18e3821264958d0 *dev/countlinesofcode.R
754314a32bcdbb1835d90b0f59339b60 *dev/hexsticker.R
9088f302621cd20a9c66012367b9c2a2 *dev/install_RAQSAPI.R
6ff6ae2460202c94a0dab25c4cc178de *dev/install_RAQSAPI.R
3c41777493d242206848842b6ba74fde *inst/CITATION
3df907b50c4f00bc26ee6d988e0c849f *inst/codecov.yml
dd65d70b425fb86f7c8b6d8841a837d8 *inst/schemaorg.json
Expand Down Expand Up @@ -403,8 +403,8 @@ f7ea691da1baf266047ed7af4b0c4629 *RAQSAPI.Rcheck/tests/testthat/test-bypqao.R
3e2e78ef3cf7666c3c041ff1b5bec788 *RAQSAPI.Rcheck/tests/testthat/testthat-problems.rds
a69de5455537022556f014579766be59 *RAQSAPI.Rproj
cfb9487651a3162cdb4308fb94e30719 *RAQSAPI_2.0.5.tar.gz
210e4ced806d419fa4b5edbb7f3fc2c4 *README.md
10f9e33622104f2df281fb4119a09d36 *README.Rmd
0860b0b61066e79ce6540b84d1d3aa04 *README.md
b2370e0e3f63a29557cd8f74746d74f6 *README.Rmd
7ed08f3fb96a77ec01c95c2ad7964250 *revdep/data.sqlite
34952a5944548ea4fc132a9899f8e6ab *revdep/email.yml
b7715aa47f5635cfb52f34937886aedf *revdep/library/RAQSAPI/old/askpass/DESCRIPTION
Expand Down Expand Up @@ -1599,11 +1599,11 @@ f7ea691da1baf266047ed7af4b0c4629 *tests/testthat/test-bypqao.R
051416af24d0386f084eb13a14053ce1 *tests/testthat/test-bystate.R
014b81fb9c8d2350e1347841f41b24a3 *tests/testthat/test-helperfunctions.R
e897203bb026b43141e5bc00dfe3cecd *tests/testthat/test-RAQSAPlistfunctions.R
8ec3157359d9a0fbdf126ed74f399ee1 *vignettes/Acknowledgements.html
e4d3a123b14a89ab800c5e143d19da61 *vignettes/Acknowledgements.html
49025d261826350f3050e677eab9dbac *vignettes/Acknowledgements.Rmd
22d607e5d49e10047a911e5d42183c34 *vignettes/acs-nano.csl
0ec78b946a45069323acf54a24c77566 *vignettes/american-chemical-society.csl
39365075c6f1d3ae375438054d27cb89 *vignettes/AQSAPI.bib
2afd7b01c6150e217d3989e7a704813e *vignettes/AQSAPI.bib
de323c3deb36e066a7583c5b756ae49b *vignettes/EPA_Disclaimer.html
a79d926b2ab509e6a9e575539b205280 *vignettes/EPA_Disclaimer.Rmd
9f8f6638c5178a9bec62665b4cef5e1d *vignettes/figures/AQS_LOGO.png
Expand All @@ -1612,6 +1612,8 @@ ce3de92ce1a1d0851726b5ae8b384b79 *vignettes/figures/RAQSAPIhexsticker.png
69224454907b49f3de5fcf3527a3ad3f *vignettes/InstallandSetup.Rmd
67dad9bb335f711013028746cf7ed61a *vignettes/Intro.html
07bc02844f0f6f2c93d40603e140f41b *vignettes/Intro.Rmd
c964de5f5bcde0fd3f1c7f6beaf6a4d5 *vignettes/pyaqsapi.html
033bd87a1e01afb5b3ceb828477c14ec *vignettes/pyaqsapi.Rmd
bce644f7c50a618fee8429b3655e5fb9 *vignettes/RAQSAPIFunctions-Brief.html
1dbae57a3f574ccd77b4d2af2c76e831 *vignettes/RAQSAPIFunctions-Brief.Rmd
9b96ebd481321226caedaa7ab4472d05 *vignettes/RAQSAPIFunctions-Long.html
Expand All @@ -1621,9 +1623,9 @@ f6a1f578b9267b1182c4c3845fc68fb0 *vignettes/RAQSAPIPurpose.html
b676d49a421ed0b581e2b3269bac31e0 *vignettes/RAQSAPIPurpose.Rmd
c0099b9c0fa4d49121ad8d61078d13a7 *vignettes/RAQSAPIusagetipsandprecautions.html
629b81e7f6056a9411e2ce16e4dfc5c8 *vignettes/RAQSAPIusagetipsandprecautions.Rmd
ddee30d7df25285648d9979febbe2192 *vignettes/RAQSAPIvignette.html
d967c391017eb8f22c7c7ceff7269cce *vignettes/RAQSAPIvignette.html
5f614b6e23d520d2260f9f7224fe648d *vignettes/RAQSAPIvignette.R
cc873a7101715766a6057c2cbb59609d *vignettes/RAQSAPIvignette.Rmd
1bccb2dcacdd37bdf82da7a99a4999ea *vignettes/RAQSAPIvignette.Rmd
3f74dfc92a4d9d85a467f20a1907fd87 *vignettes/TimelinessofAQSData.html
5d3445414bf02629a8a10b6dc05c47e7 *vignettes/TimelinessofAQSData.Rmd
06345a3820be1e248082b211e2bcb708 *vignettes/Troubleshooting.html
Expand Down
3 changes: 3 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ knitr::opts_chunk$set(
```{r child = "./vignettes/RAQSAPIFunctions-Brief.Rmd"}
```

```{r child = "./vignettes/pyaqsapi.Rmd"}
```

```{r child = "./vignettes/Acknowledgements.Rmd"}
```

Expand Down
50 changes: 37 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Clinton Mccrowey, physical scientist - US EPA
- [Data Mart aggregate functions](#data-mart-aggregate-functions)
- [See the RAQSAPI vignette for more
details](#see-the-raqsapi-vignette-for-more-details)
- [pyaqsapi - a port of RAQSAPI to the python 3 programming
environment](#pyaqsapi---a-port-of-raqsapi-to-the-python-3-programming-environment)
- [Acknowledgements](#acknowledgements)
- [References](#references)

Expand All @@ -37,7 +39,7 @@ status](https://www.r-pkg.org/badges/version/RAQSAPI)](https://CRAN.R-project.or
downloads](https://cranlogs.r-pkg.org/badges/RAQSAPI)](https://cran.r-project.org/package=RAQSAPI)
[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
[![license](https://img.shields.io/badge/license-CC0-lightgrey.svg)](https://choosealicense.com/)
[![Last-changedate](https://img.shields.io/badge/last%20change-%202023--11--28-yellowgreen.svg)](/commits/master)
[![Last-changedate](https://img.shields.io/badge/last%20change-%202023--12--01-yellowgreen.svg)](/commits/master)
<!-- badges: end -->

# EPA Disclaimer
Expand Down Expand Up @@ -382,6 +384,18 @@ where \<service\> is one of the 13 services listed above and
RShowDoc(what="RAQSAPIvignette", type="html", package="RAQSAPI")
```

## pyaqsapi - a port of RAQSAPI to the python 3 programming environment

For users that feel more comfortable working within a python 3
environment, [pyaqsapi](https://github.com/USEPA/pyaqsapi)<sup>4</sup>,
a port of RAQSAPI to the python 3 language has been released. Both
projects aim to maintain feature parity with the other and there are no
inherent advantages to using either project over the other, except for
the ability of working within the programming language environment of
choice. The API of both packages are very structured similarly, both
packages export the same data, use the same credentials and data source
to retrieve data.

# Acknowledgements

RAQSAPI was included in the Rblogger’s March 2021: “Top 40” [New CRAN
Expand All @@ -391,17 +405,17 @@ The RAQSAPI package borrows upon functions and code provided by sources
not mentioned in the DESCRIPTION file. Here we attempt to acknowledge
those sources with them RAQSAPI would not be possible.

- README badges are provided by R package `badgecreator`<sup>4</sup>.
- The R package `usethis`<sup>5</sup> was used to generate GitHub
- README badges are provided by R package `badgecreator`<sup>5</sup>.
- The R package `usethis`<sup>6</sup> was used to generate GitHub
actions for Continuous integration (CI).
- Code cleanup was assisted by the R package `lintr`<sup>6</sup>
- Code cleanup was assisted by the R package `lintr`<sup>7</sup>
- the function *install.packages* are provided by the R package
`utils`<sup>7</sup>
`utils`<sup>8</sup>
- the function *install_github* are provided by the R package
`remotes`<sup>8</sup>
`remotes`<sup>9</sup>
- .gitignore file borrowed examples from
<https://github.com/github/gitignore/blob/master/R.gitignore>
- The RAQSAPI hexsticker was created using the `hexSticker`<sup>9</sup>
- The RAQSAPI hexsticker was created using the `hexSticker`<sup>10</sup>
package for R

# References
Expand Down Expand Up @@ -433,9 +447,19 @@ Simple Data Frames](https://CRAN.R-project.org/package=tibble)*;

</div>

<div id="ref-package:badgecreatr" class="csl-entry">
<div id="ref-py3package:pyaqsapi" class="csl-entry">

<span class="csl-left-margin">(4)
</span><span class="csl-right-inline">Mccrowey, C. A Python 3 Package to
Retrieve Ambient Air Monitoring Data from the United States
Environmental Protection Agency’s (US EPA) Air Quality System (AQS) Data
Mart API V2 Interface, 2022. <https://github.com/USEPA/pyaqsapi>.</span>

</div>

<div id="ref-package:badgecreatr" class="csl-entry">

<span class="csl-left-margin">(5)
</span><span class="csl-right-inline">Hogervorst, R. M. *[Badgecreatr:
Create Badges for ’Travis’, ’Repostatus’ ’Codecov.io’ Etc in Github
Readme](https://CRAN.R-project.org/package=badgecreatr)*; 2019.</span>
Expand All @@ -444,7 +468,7 @@ Readme](https://CRAN.R-project.org/package=badgecreatr)*; 2019.</span>

<div id="ref-package:usethis" class="csl-entry">

<span class="csl-left-margin">(5)
<span class="csl-left-margin">(6)
</span><span class="csl-right-inline">Wickham, H.; Bryan, J.; Barrett,
M. *[Usethis: Automate Package and Project
Setup](https://CRAN.R-project.org/package=usethis)*; 2021.</span>
Expand All @@ -453,7 +477,7 @@ Setup](https://CRAN.R-project.org/package=usethis)*; 2021.</span>

<div id="ref-package:lintr" class="csl-entry">

<span class="csl-left-margin">(6)
<span class="csl-left-margin">(7)
</span><span class="csl-right-inline">Hester, J.; Angly, F.; Hyde, R.
*[Lintr: A ’Linter’ for r
Code](https://CRAN.R-project.org/package=lintr)*; 2020.</span>
Expand All @@ -462,7 +486,7 @@ Code](https://CRAN.R-project.org/package=lintr)*; 2020.</span>

<div id="ref-RBase" class="csl-entry">

<span class="csl-left-margin">(7)
<span class="csl-left-margin">(8)
</span><span class="csl-right-inline">Team, R. C. *[R: A Language and
Environment for Statistical Computing](https://www.R-project.org/)*; R
Foundation for Statistical Computing: Vienna, Austria, 2019.</span>
Expand All @@ -471,7 +495,7 @@ Foundation for Statistical Computing: Vienna, Austria, 2019.</span>

<div id="ref-package:remotes" class="csl-entry">

<span class="csl-left-margin">(8)
<span class="csl-left-margin">(9)
</span><span class="csl-right-inline">Csárdi, G.; Hester, J.; Wickham,
H.; Chang, W.; Morgan, M.; Tenenbaum, D. *[Remotes: R Package
Installation from Remote Repositories, Including
Expand All @@ -481,7 +505,7 @@ Installation from Remote Repositories, Including

<div id="ref-package:hexsticker" class="csl-entry">

<span class="csl-left-margin">(9)
<span class="csl-left-margin">(10)
</span><span class="csl-right-inline">Yu, G. *[hexSticker: Create
Hexagon Sticker in r](https://CRAN.R-project.org/package=hexSticker)*;
2020.</span>
Expand Down
9 changes: 9 additions & 0 deletions vignettes/AQSAPI.bib
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,12 @@ @Manual{package:hexsticker
note = {R package version 0.4.9},
url = {https://CRAN.R-project.org/package=hexSticker},
}

@Misc{py3package:pyaqsapi,
title = {A python 3 package to retrieve ambient air monitoring data from
the United States Environmental Protection Agency’s (US EPA) Air
Quality System (AQS) Data Mart API v2 interface},
author = {Clinton Mccrowey},
year = {2022},
url = {https://github.com/USEPA/pyaqsapi},
}
3 changes: 3 additions & 0 deletions vignettes/RAQSAPIvignette.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ invisible(library(glue, warn.conflicts = FALSE, quietly = TRUE))
```{r child = "Troubleshooting.Rmd", echo = FALSE}
```

```{r child = "pyaqsapi.Rmd", echo = FALSE}
```

```{r child = "Acknowledgements.Rmd", echo = FALSE}
```

Expand Down
36 changes: 36 additions & 0 deletions vignettes/pyaqsapi.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "pyaqsapi - a port of RAQSAPI to the python 3 programming environment"
author:
- affiliation: |-
United States Environmental Protection Agency (US EPA),
Region III,
Air and Radiation Division,
Air Quality and Analysis Branch
name: Clinton Mccrowey
output:
rmarkdown::html_vignette: default
lang: en-US
bibliography: ./AQSAPI.bib
csl: ./acs-nano.csl
vignette: >
%\VignetteIndexEntry{pyaqsapi - a port of RAQSAPI to the python 3 programming environment}
%\VignetteEncoding{UTF-8}
%\VignetteDepends{knitr}
%\VignetteDepends{rmarkdown}
%\VignetteEngine{knitr::rmarkdown}
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

## pyaqsapi - a port of RAQSAPI to the python 3 programming environment

For users that feel more comfortable working within a python 3 environment,
[pyaqsapi](https://github.com/USEPA/pyaqsapi) [@py3package:pyaqsapi],
a port of RAQSAPI to the python 3 language has been released. Both projects aim
to maintain feature parity with the other and there are no inherent advantages
to using either project over the other, except for the ability of working within
the programming language environment of choice. The API of both packages are
very structured similarly, both packages export the same data, use the same
credentials and data source to retrieve data.

0 comments on commit 2f4c016

Please sign in to comment.