Data

Tools

Indexes

Applications

Experiments

Open Source Science

opensensmapr

R client for opensensemap.org

https://github.com/sensebox/opensensmapr

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 4 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary

Keywords

analysis open-data opensensemap r sensebox sensor
Last synced: 6 months ago · JSON representation

Repository

R client for opensensemap.org

Basic Info
Statistics
  • Stars: 8
  • Watchers: 3
  • Forks: 5
  • Open Issues: 7
  • Releases: 0
Topics
analysis open-data opensensemap r sensebox sensor
Created over 8 years ago · Last pushed almost 3 years ago
Metadata Files
Readme

README.md

opensensmapr

CRAN status Travis build status AppVeyor Build 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

r install.packages('opensensmapr')

To install the very latest versions from GitHub, run:

r 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 NEWS.md.

Contributing & Development

Contributions are very welcome! When submitting a patch, please follow the existing code stlye, 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.

development environment

To set up the development environment for testing and checking, all suggested packages should be installed. On linux, these require some system dependencies: ```sh

install dependencies for sf (see https://github.com/r-spatial/sf#installing)

sudo dnf install gdal-devel proj-devel proj-epsg proj-nad geos-devel udunits2-devel

install suggested packages

R -e "install.packages(c('maps', 'maptools', 'tibble', 'rgeos', 'sf', 'knitr', 'rmarkdown', 'lubridate', 'units', 'jsonlite', 'ggplot2', 'zoo', 'lintr', 'testthat', 'covr')" ```

build

To build the package, either use devtools::build() or run sh R CMD build .

Next, run the tests and checks: ```sh R CMD check --as-cran ../opensensmapr_*.tar.gz

alternatively, if you're in a hurry:

R CMD check --no-vignettes ../opensensmapr_*.tar.gz ```

release

To create a release:

  1. make sure you are on master branch
  2. run the tests and checks as described above
  3. bump the version in DESCRIPTION
  4. update NEWS.md
  5. rebuild the documentation: R -e 'devtools::document()'
  6. build the package again with the new version: R CMD build . --no-build-vignettes
  7. tag the commit with the new version: git tag v0.5.0
  8. push changes: git push && git push --tags
  9. wait for all CI tests to complete successfully (helps in the next step)
  10. upload the new release to CRAN
  11. get back to the enjoyable parts of your life & hope you won't get bad mail next week.

License

GPL-2.0 - Norwin Roosen

Owner

  • Name: senseBox
  • Login: sensebox
  • Kind: organization
  • Email: support@sensebox.de
  • Location: Münster, Germany

The senseBox is a Citizen Science DIY Toolbox for schools and citizens.

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 175
  • Total Committers: 4
  • Avg Commits per committer: 43.75
  • Development Distribution Score (DDS): 0.674
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
noerw n****w@g****e 57
jan j****7@u****e 52
Norwin Roosen g****b@n****e 51
nuest d****t@u****e 15
Committer Domains (Top 20 + Academic)
uni-muenster.de: 2 nroo.de: 1 gmx.de: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 27
  • Total pull requests: 4
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 8 hours
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.96
  • Average comments per pull request: 1.5
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • noerw (16)
  • nuest (9)
  • edzer (1)
Pull Request Authors
  • noerw (2)
  • jsten07 (1)
  • nuest (1)
Top Labels
Issue Labels
enhancement (6) package (6) bug (3) vignette (2) help wanted (2) upstream (2) tools (1)
Pull Request Labels
work in progress (1)

Packages

  • Total packages: 1
  • Total downloads:
    • cran 182 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
cran.r-project.org: opensensmapr

Client for the Data API of 'openSenseMap.org'

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 182 Last month
Rankings
Forks count: 11.3%
Stargazers count: 19.8%
Dependent packages count: 29.8%
Average: 30.2%
Dependent repos count: 35.5%
Downloads: 54.7%
Maintainers (1)
jan.stenkamp@uni-muenster.de
Last synced: 8 months ago