R client for opensensemap.org
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
noerw 925909ebe8 finally workaround / fix #22 11 meses atrás
.aspell hello CRAN :^| 1 ano atrás
R fix osem_as_measurements 11 meses atrás
inst/doc update vignette to workaround #22 ...again 11 meses atrás
man update docs + vignette builds 1 ano atrás
tests fix osem_as_measurements 11 meses atrás
tools/monitr too many `e`s are not healthy 1 ano atrás
vignettes finally workaround / fix #22 11 meses atrás
.Rbuildignore v0.4.1 11 meses atrás
.gitattributes add .gitattributes 1 ano atrás
.gitignore make R CMD check happy 1 ano atrás
.lintr add lintr config, make code lint compliant, fixes #20 1 ano atrás
.travis.yml attempt to build vignettes on travis 11 meses atrás
CHANGES.md v0.4.1 11 meses atrás
CONDUCT.md add coc 1 ano atrás
DESCRIPTION v0.4.1 11 meses atrás
LICENSE Initial commit 1 ano atrás
NAMESPACE add caching feature 1 ano atrás
README.md clarify README 11 meses atrás
appveyor.yml add appveyor config 1 ano atrás
codecov.yml add codecov configuration 1 ano atrás

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