opensensemap/opensensmapR
1
0
Fork 0
mirror of https://github.com/sensebox/opensensmapr synced 2025-06-04 04:06:09 +02:00
Code Issues Releases Wiki Activity
R client for opensensemap.org
108 commits 4 branches 10 tags 9.2 MiB
R 98.6%
Dockerfile 0.9%
Shell 0.5%
Find a file
Exact
Norwin Roosen 18a698b375 add some tests for osem_measurements_archive
2018-10-20 01:48:33 +02:00
.aspell hello CRAN :^| 2018-05-14 00:56:10 +02:00
inst/doc change references to sensebox org 2018-09-05 10:27:55 +02:00
man add osem_measurement_archive() 2018-10-18 16:31:30 +02:00
R document osem_measurements_archive 2018-10-20 01:25:45 +02:00
tests add some tests for osem_measurements_archive 2018-10-20 01:48:33 +02:00
tools/monitr change references to sensebox org 2018-09-05 10:27:55 +02:00
vignettes change references to sensebox org 2018-09-05 10:27:55 +02:00
.gitattributes add .gitattributes 2017-11-29 14:21:04 +01:00
.gitignore make R CMD check happy 2018-05-26 12:52:30 +02:00
.lintr add lintr config, make code lint compliant, fixes #20 2018-05-07 01:32:11 +02:00
.Rbuildignore v0.4.1 2018-06-07 00:20:20 +02:00
.travis.yml attempt to build vignettes on travis 2018-06-11 19:32:45 +02:00
appveyor.yml add appveyor config 2018-01-14 22:13:45 +01:00
CHANGES.md v0.4.3 2018-09-21 12:21:22 +02:00
codecov.yml add codecov configuration 2018-01-14 21:50:10 +01:00
CONDUCT.md add coc 2018-01-14 22:14:32 +01:00
DESCRIPTION add osem_measurement_archive() 2018-10-18 16:31:30 +02:00
LICENSE Initial commit 2017-08-13 14:16:17 +00:00
NAMESPACE document osem_measurements_archive 2018-10-20 01:25:45 +02:00
README.md v0.4.3 2018-09-21 12:21:22 +02:00

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('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