R client for opensensemap.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
noerw 925909ebe8 finally workaround / fix #22 пре 1 година
.aspell hello CRAN :^| пре 1 година
R fix osem_as_measurements пре 1 година
inst/doc update vignette to workaround #22 ...again пре 1 година
man update docs + vignette builds пре 1 година
tests fix osem_as_measurements пре 1 година
tools/monitr too many `e`s are not healthy пре 1 година
vignettes finally workaround / fix #22 пре 1 година
.Rbuildignore v0.4.1 пре 1 година
.gitattributes add .gitattributes пре 1 година
.gitignore make R CMD check happy пре 1 година
.lintr add lintr config, make code lint compliant, fixes #20 пре 1 година
.travis.yml attempt to build vignettes on travis пре 1 година
CHANGES.md v0.4.1 пре 1 година
CONDUCT.md add coc пре 1 година
DESCRIPTION v0.4.1 пре 1 година
LICENSE Initial commit пре 2 година
NAMESPACE add caching feature пре 1 година
README.md clarify README пре 1 година
appveyor.yml add appveyor config пре 1 година
codecov.yml add codecov configuration пре 1 година

README.md

opensensmapr

CRAN status Travis build status AppVeyor Build Status Coverage status

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 filters
  • osem_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:

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('noerw/opensensmapr@master')      # latest stable version
devtools::install_github('noerw/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.

License

GPL-2.0 - Norwin Roosen