R client for opensensemap.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
nuest 8e1fb7ad10 add appveyor config 1 year ago
R add function wrapper for default endpoint 1 year ago
inst/doc update vignette build 2 years ago
man add function wrapper for default endpoint 1 year ago
tests add tests for phenomena and box 1 year ago
tools/monitr too many `e`s are not healthy 1 year ago
vignettes rename osem_as_sf to st_as_sf.sensebox 2 years ago
.Rbuildignore add tests and Travis CI configuration 1 year ago
.gitattributes add .gitattributes 1 year ago
.gitignore make R CMD check --as-cran pass 1 year ago
.travis.yml fix travis tests 1 year ago
CHANGES.md v0.3.2 1 year ago
DESCRIPTION add tests and Travis CI configuration 1 year ago
LICENSE Initial commit 2 years ago
NAMESPACE add function wrapper for default endpoint 1 year ago
README.md add function wrapper for default endpoint 1 year ago
appveyor.yml add appveyor config 1 year ago
codecov.yml add codecov configuration 1 year ago

README.md

opensensmapr

CRAN status Travis build status AppVeyor Build Status Coverage status

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.

Development

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