You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1.9 KiB

Raw Permalink Blame History

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

1.9 KiB Raw Permalink Blame History