Download environmental measurements and sensor station metadata from the API of open data sensor web platform < https://opensensemap.org> for analysis in R. This platform provides real time data of more than 1500 low-cost sensor stations for PM10, PM2.5, temperature, humidity, UV-A intensity and more phenomena. The package aims to be compatible with 'sf' and the 'Tidyverse', and provides several helper functions for data exploration and transformation.
This R package ingests data from the API of opensensemap.org for analysis in R.
osem_boxes(): fetch sensor station ("box") metadata, with various filters
osem_measurements(): fetch measurements by phenomenon, with various filters such as submitting spatial extent, time range, sensor type, box, exposure..
Complete documentation is provided via the R help system:
Each function's documentation can be viewed with
A comprehensive overview of all functions is given in
There are also vignettes showcasing applications of this package:
If you used this package for an analysis and think it could serve as a good example or showcase, feel free to add a vignette to the package via a PR!
The package is available on CRAN, install it via
To install the very latest versions from GitHub, run:
install.packages('devtools')devtools::install_github('sensebox/[email protected]') # latest stable versiondevtools::install_github('sensebox/[email protected]') # bleeding edge version
This project adheres to semantic versioning, for changes in recent versions please consult CHANGES.md.
Contributions are very welcome!
When submitting a patch, please follow the existing code style,
R CMD check --no-vignettes . on the package.
Where feasible, also add tests for the added / changed functionality in
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
To set up the development environment for testing and checking, all suggested packages should be installed. On linux, these require some system dependencies:
# install dependencies for sf (see )sudo dnf install gdal-devel proj-devel proj-epsg proj-nad geos-devel udunits2-devel# install suggested packagesR -e "install.packages(c('maps', 'maptools', 'tibble', 'rgeos', 'sf','knitr', 'rmarkdown', 'lubridate', 'units', 'jsonlite', 'ggplot2','zoo', 'lintr', 'testthat', 'covr')"
To build the package, either use
devtools::build() or run
R CMD build .
Next, run the tests and checks:
R CMD check --as-cran ../opensensmapr_*.tar.gz# alternatively, if you're in a hurry:R CMD check --no-vignettes ../opensensmapr_*.tar.gz
To create a release:
R -e 'devtools::document()'
R CMD build . --no-build-vignettes
git tag v0.5.0
git push && git push --tags
GPL-2.0 - Norwin Roosen