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 5 months ago
.aspell hello CRAN :^| 7 months ago
R fix osem_as_measurements 6 months ago
inst/doc update vignette to workaround #22 ...again 6 months ago
man update docs + vignette builds 6 months ago
tests fix osem_as_measurements 6 months ago
tools/monitr too many `e`s are not healthy 1 year ago
vignettes finally workaround / fix #22 5 months ago
.Rbuildignore v0.4.1 6 months ago
.gitattributes add .gitattributes 1 year ago
.gitignore make R CMD check happy 6 months ago
.lintr add lintr config, make code lint compliant, fixes #20 7 months ago
.travis.yml attempt to build vignettes on travis 6 months ago
CHANGES.md v0.4.1 6 months ago
CONDUCT.md add coc 10 months ago
DESCRIPTION v0.4.1 6 months ago
LICENSE Initial commit 1 year ago
NAMESPACE add caching feature 6 months ago
README.md clarify README 5 months ago
appveyor.yml add appveyor config 10 months ago
codecov.yml add codecov configuration 10 months ago

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