https://github.com/openaq/openaq-r
openaq R client
https://github.com/openaq/openaq-r
air-quality api openaq r
Last synced: about 2 months ago
JSON representation
openaq R client
- Host: GitHub
- URL: https://github.com/openaq/openaq-r
- Owner: openaq
- License: other
- Created: 2025-01-23T18:14:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-26T21:21:44.000Z (about 2 months ago)
- Last Synced: 2025-03-26T21:34:03.197Z (about 2 months ago)
- Topics: air-quality, api, openaq, r
- Language: R
- Homepage: https://openaq.github.io/openaq-r/
- Size: 2.52 MB
- Stars: 5
- Watchers: 0
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# openaq R client 
[](https://www.repostatus.org/#wip)
[](https://github.com/openaq/openaq-r/actions/workflows/check.yaml)
[](https://app.codecov.io/gh/openaq/openaq-r)
An R package for interacting with the OpenAQ API.
## Installation
The package is available to install through Github. Use the `install_github` command from [remotes](https://cran.r-project.org/web/packages/remotes/index.html) package.
```r
library("remotes")
install_github("openaq/openaq-r@*release")
```
## Quickstart
For a full walkthrough on using openaq we recommend that you read through the
“[Introduction to
openaq](https://openaq.github.io/openaq-r/articles/openaq.html)”
vignette (`vignette("openaq")`). The following guide is a quick and minimal
example to get you started.
1. Register for an account at
[https://explore.openaq.org/register](https://explore.openaq.org/register).
2. Find your API key in the user [account page](https://explore.openaq.org/account).
3. Save your API key as the `OPENAQ_API_KEY` [environment
variable](https://rstats.wtf/r-startup.html#renviron) . e.g.
`OPENAQ_API_KEY=yourkey` in `.Renviron`. See `help(openaq)` for other ways to use and access your API key.
Now we can query OpenAQ for air quality monitoring locations. For this example we will query locations that measure PM2.5 near (with 10km) Antananarivo, Madagascar (-18.90848, 47.53751)
```r
library(openaq)
locations <- list_locations(
parameters_id = 2,
coordinates = c(latitude = -18.90848, longitude = 47.53751),
radius = 10000
)
```
This returns a data frame that will look something like:
| id|name |is_mobile |is_monitor |timezone | countries_id|country_name |country_iso | latitude| longitude|datetime_first |datetime_last |owner_name | providers_id|provider_name |
|-----:|:------------|:------------|:----------|:-------------------|------------:|:------------|:-----------|---------:|---------:|:-------------------|:-------------------|:---------------------------------|------------:|:-------------|
| 41726|Antananarivo |FALSE |TRUE |Indian/Antananarivo | 182|Madagascar |MG | -18.90848| 47.53751|2020-12-22 07:00:00 |2025-01-17 20:00:00 |Unknown Governmental Organization | 119|AirNow |
## Development
Contributions are welcome. See the [contribution guide](CONTRIBUTING.md) for general information about contributing to the package.
Specific guidelines for contributions the openaq package:
* Code contributions must follow lint convention using [`lintr`](https://lintr.r-lib.org/),
see the .lintr file for specifics.
* Code contributions must include unit test, iether updated or wholly new,
depending on the contribution. See testing [README](tests/README.md) for more information.
* Limit new dependencies. While adding new external dependencies is not out of
the question, we seek to keep external dependencies at a minimum. When possible
use base R functionality. Code contributions that rely on external dependencies
should be discussed with the package maintainer first.