1
0
Fork 0
mirror of https://github.com/sensebox/opensensmapr synced 2025-07-15 22:13:50 +02:00
R client for opensensemap.org
Find a file
2018-01-13 16:19:50 +01:00
inst/doc update vignette build 2017-08-25 11:37:03 +02:00
man make R CMD check --as-cran pass 2018-01-13 15:17:23 +01:00
R fix summary.sensebox() last_measurement_within 2018-01-13 16:17:59 +01:00
tools/monitr too many es are not healthy 2017-12-01 20:54:16 +01:00
vignettes rename osem_as_sf to st_as_sf.sensebox 2017-08-25 11:37:03 +02:00
.gitattributes add .gitattributes 2017-11-29 14:21:04 +01:00
.gitignore make R CMD check --as-cran pass 2018-01-13 15:17:23 +01:00
.Rbuildignore make R CMD check --as-cran pass 2018-01-13 15:17:23 +01:00
CHANGES.md v0.3.2 2018-01-13 16:19:50 +01:00
DESCRIPTION v0.3.2 2018-01-13 16:19:50 +01:00
LICENSE Initial commit 2017-08-13 14:16:17 +00:00
NAMESPACE make R CMD check --as-cran pass 2018-01-13 15:17:23 +01:00
README.md document osem_as_sensebox() (#13) 2018-01-13 15:16:11 +01:00

opensensmapr

This R package ingests data (environmental measurements, sensor stations) from the API of opensensemap.org for analysis in R. The package aims to be compatible with sf and the tidyverse.

Installation

Right now, the package is not on CRAN. To install it from GitHub, run:

install.packages('devtools')
devtools::install_github('noerw/opensensmapr')

Usage

A verbose usage example is shown in the vignette osem-intro. Each functions documentation can be viewed with ?<function-name>. An overview is given in ?opensensmapr. In short, the following pseudocode shows the main functions for data retrieval:

# retrieve a single box by id, or many boxes by some property-filters
b = osem_box('boxId')
b = osem_boxes(filter1, filter2, ...)

# get the counts of observed phenomena for a list of boxes
p = osem_phenomena(b)

# get measurements for a phenomenon
m = osem_measurements(phenomenon, filter1, ...)
# get measurements for a phenomenon from selected boxes
m = osem_measurements(b, phenomenon, filter1, ...)
# get measurements for a phenomenon from a geographic bounding box
m = osem_measurements(bbox, phenomenon, filter1, ...)

# get general count statistics of the openSenseMap database
osem_counts()

Additionally there are some helpers: summary.sensebox(), plot.sensebox(), st_as_sf.sensebox(), osem_as_sensebox(), [.sensebox(), filter.sensebox(), mutate.sensebox(), ....

Changelog

This project adheres to semantic versioning, for changes in recent versions please consult CHANGES.md.

FAQ

  • Whats up with that package name? idk, the R people seem to enjoy dropping vovels so.. Unfortunately I couldn't fit the naming convention to drop an y in there.

License

GPL-2.0 - Norwin Roosen