Norwin c4da876761 | 6 years ago | |
---|---|---|
.aspell | 6 years ago | |
R | 6 years ago | |
inst/doc | 6 years ago | |
man | 6 years ago | |
tests | 6 years ago | |
tools/monitr | 6 years ago | |
vignettes | 6 years ago | |
.Rbuildignore | 6 years ago | |
.gitattributes | 6 years ago | |
.gitignore | 6 years ago | |
.lintr | 6 years ago | |
.travis.yml | 6 years ago | |
CHANGES.md | 6 years ago | |
CONDUCT.md | 6 years ago | |
DESCRIPTION | 6 years ago | |
LICENSE | 7 years ago | |
NAMESPACE | 6 years ago | |
README.md | 6 years ago | |
appveyor.yml | 6 years ago | |
codecov.yml | 6 years ago |
README.md
opensensmapr
This R package ingests data from the API of opensensemap.org for analysis in R.
Features include:
osem_boxes()
: fetch sensor station ("box") metadata, with various filtersosem_measurements()
: fetch measurements by phenomenon, with various filters such as submitting spatial extent, time range, sensor type, box, exposure..- no time frame limitation through request paging!
- many helper functions to help understand the queried data
- caching queries for reproducibility
The package aims to be compatible with the tidyverse
and sf
,
so it is easy to analyze or vizualize the data with state of the art packages.
Usage
Complete documentation is provided via the R help system:
Each function's documentation can be viewed with ?<function-name>
.
A comprehensive overview of all functions is given in ?opensensmapr
.
There are also vignettes showcasing applications of this package:
- Visualising the History of openSenseMap.org: Showcase of
opensensmapr
withdplyr
+ggplot2
- Exploring the openSenseMap dataset: Showcase of included helper functions
- Caching openSenseMap Data for reproducibility
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!
Installation
The package is available on CRAN, install it via
install.packages('opensensmapr')
To install the very latest versions from GitHub, run:
install.packages('devtools')
devtools::install_github('sensebox/opensensmapr@master') # latest stable version
devtools::install_github('sensebox/opensensmapr@development') # bleeding edge version
Changelog
This project adheres to semantic versioning, for changes in recent versions please consult CHANGES.md.
Contributing & Development
Contributions are very welcome!
When submitting a patch, please follow the existing code style,
and run R CMD check --no-vignettes .
on the package.
Where feasible, also add tests for the added / changed functionality in tests/testthat
.
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.
build
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
License
GPL-2.0 - Norwin Roosen