1
0
Fork 0
mirror of https://github.com/sensebox/opensensmapr synced 2025-06-30 17:00:21 +02:00
R client for opensensemap.org
Find a file
2017-09-04 23:47:30 +02:00
inst/doc update vignette build 2017-08-25 11:37:03 +02:00
man rename osem_as_sf to st_as_sf.sensebox 2017-08-25 11:37:03 +02:00
R rename osem_as_sf to st_as_sf.sensebox 2017-08-25 11:37:03 +02:00
tools/monitor rename osem_as_sf to st_as_sf.sensebox 2017-08-25 11:37:03 +02:00
vignettes rename osem_as_sf to st_as_sf.sensebox 2017-08-25 11:37:03 +02:00
.gitignore add vignette builds to version control 2017-08-23 15:40:06 +02:00
.Rbuildignore rename to opensensmapr 2017-08-13 16:24:37 +02:00
CHANGES.md v0.3.0 2017-09-04 23:47:30 +02:00
DESCRIPTION v0.3.0 2017-09-04 23:47:30 +02:00
LICENSE Initial commit 2017-08-13 14:16:17 +00:00
NAMESPACE rename osem_as_sf to st_as_sf.sensebox 2017-08-25 11:37:03 +02:00
README.md update vignette build 2017-08-25 11:37:03 +02: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.

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.

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 usage example is shown in the vignette osem-intro. In general these are 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(), [.sensebox(), filter.sensebox(), mutate.sensebox(), ....

For parameter usage, open each functions' documentation by calling ?<function-name>.

License

GPL-2.0 - Norwin Roosen