R client for opensensemap.org
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
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