analyse-together

A tool for analysis of air quality data, measured by low cost sensors

https://github.com/rivm-syso/analyse-together

Science Score: 44.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

airquality airquality-sensor citizen-participation citizen-science
Last synced: 7 months ago · JSON representation ·

Repository

A tool for analysis of air quality data, measured by low cost sensors

Basic Info
  • Host: GitHub
  • Owner: rivm-syso
  • License: gpl-3.0
  • Language: R
  • Default Branch: master
  • Homepage:
  • Size: 1.03 MB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 20
  • Releases: 5
Topics
airquality airquality-sensor citizen-participation citizen-science
Created about 4 years ago · Last pushed 9 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

Analyse Together

With this tool you can explore the sensordata of the Dutch Measure Together project with official measurement data from the National Air Monitoring Network, or, for example, compare your neighbourhood with a neighbourhood nearby.

This tool is an R Shiny application and still under heavy development. So, expect that things change often. For running this tool, please see below.

Accessing the tool

To access the tool go to this link. We appreciate your feedback, use the issues or our forum.

Versions and branches

This tool has three versions, maintained in three branches. The develop branch is the bleeding edge version where you can find the newest features and try outs. The testing and accpt branches contain the internal and external testing versions respectively. These version are used for others besides the developers to test the app. The main branch will contain the production ready version.

Running the tool yourself

This is for experts only ;-). For running this tool you have two options, run it in you own RStudio environment, or run a container with the app using Docker.

To run the tool, you must also create a database, see below. While working with the app, you get data from several sources and this data is stored in the database. As long as you keep the database, you keep your downloaded data.

Running using R (or RStudio)

To run this app in R, clone this repository using your Git sofware or clone directly in RStudio. Then run the app as an regular Shiny App. You probably need to install some packages, have a look in the upper part of global.R for the packages you need.

Running using Docker

When you want the app in a Docker container, then clone repository on your local system. Our containers are based on Rocker. All needed packages are installed during the build. You have either to include the database in the container, or use a volume to mount a local database into the container.

After cloning the container, build it using Docker and then run. When running the container dont' forget to port-forward the Shiny port using `Docker run [...] -p 3838:3838 [...]. After running your Docker container, point your browser to http://localhost:3838 to see the app.

Create the database

In the scripts directory you can find several scripts which we use as tools to maintain and test the app. The scripts scripts/makebigdatabase.R creates a database containing data from 5 Dutch municipalities. This gives you some data to play with. Be aware, downloading the data can take a while (hours, in some cases). To create an empty database, use the script scripts/init_database.R.

Contributing and Code of Conduct

Contributions of all sorts are most welcome. Issues and pull requests are the preferred ways of sharing them.

Please note that Analyse Together uses a Contributor Code of Conduct By contributing to this project, you agree to abide by its terms.

Licence

This projects is licenced using the Open Source GPL-3 licence, please see the licence for details

Owner

  • Name: Rijksinstituut voor Volksgezondheid en Milieu
  • Login: rivm-syso
  • Kind: organization
  • Email: info@rivm.nl
  • Location: Bilthoven, The Netherlands

Citation (CITATION.cff)

cff-version: 1.2.0
title: Analyse Together
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Elma
    family-names: Tenner
    email: elma.tenner@rivm.nl
    affiliation: >-
      National Institute for Public Health and the
      Environment
  - given-names: Wouter
    family-names: Hendricx
    email: wouter.hendricx@rivm.nl
    affiliation: >-
      National Institute for Public Health and the
      Environment
    orcid: 'https://orcid.org/0000-0002-9893-2062'
  - given-names: Job
    family-names: Spijker
    email: job.spijker@rivm.nl
    affiliation: >-
      National Institute for Public Health and the
      Environment
    orcid: 'https://orcid.org/0000-0001-9276-2640'
  - given-names: Sanne
    family-names: Ypenburg
    email: sanne.ypenburg@rivm.nl
    affiliation: >-
      National Institute for Public Health and the
      Environment
    orcid: 'https://orcid.org/0000-0003-1114-1311'
contact:
  - email: samenmeten@rivm.nl
    name: "National Institute for Public Health and the Environment"
repository-code: 'https://github.com/rivm-syso/Analyse-Together'
url: 'https://analyseren.samenmeten.nl/'
abstract: With this tool you can explore the sensordata of the Dutch Measure Together project with official measurement data from the National Air Monitoring Network, or, for example, compare your neighbourhood with a neighbourhood nearby.
keywords:
  - citizens science
  - air quality
  - RIVM
  - shiny
  - sensor
  - samenmeten
license: GPL-3.0
version: 2.0.5
doi: 10.21945/a32c33e3-8a98-4a69-8996-93a08f4e3a37
date-released: 2024-07-18

GitHub Events

Total
  • Issues event: 24
  • Watch event: 1
  • Delete event: 11
  • Issue comment event: 22
  • Push event: 46
  • Pull request event: 35
  • Pull request review event: 18
  • Pull request review comment event: 3
  • Create event: 11
Last Year
  • Issues event: 24
  • Watch event: 1
  • Delete event: 11
  • Issue comment event: 22
  • Push event: 46
  • Pull request event: 35
  • Pull request review event: 18
  • Pull request review comment event: 3
  • Create event: 11

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 336
  • Total Committers: 10
  • Avg Commits per committer: 33.6
  • Development Distribution Score (DDS): 0.679
Past Year
  • Commits: 232
  • Committers: 10
  • Avg Commits per committer: 23.2
  • Development Distribution Score (DDS): 0.586
Top Committers
Name Email Commits
tennere e****r@r****l 108
spijker j****r@r****l 81
hendricw w****x@r****l 69
Sanne Ypenburg s****g@r****l 29
Hendricxw 6****w 21
schuchw w****h@r****l 15
elma13 3****3 8
Sanne Ypenburg s****g@g****m 3
Job Spijker j****e@r****l 1
Eline Verhoeven v****e@r****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 2 years ago

All Time
  • Total issues: 58
  • Total pull requests: 57
  • Average time to close issues: 2 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 1.6
  • Average comments per pull request: 0.23
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 46
  • Pull requests: 57
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 3 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 1.54
  • Average comments per pull request: 0.23
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • elma13 (90)
  • jspijker (22)
  • Hendricxw (3)
Pull Request Authors
  • elma13 (101)
  • jspijker (40)
  • Hendricxw (4)
Top Labels
Issue Labels
next_release (13) bug (12) enhancement (10) in review (1)
Pull Request Labels

Dependencies

CONTAINER/config-r/Dockerfile docker
  • rivm-shinyapps-ct/analyse-together sys build
CONTAINER/config-sys/Dockerfile docker
  • rivm-shinyapps-ct/rocker-shiny-verse latest build
Dockerfile docker
  • rocker/shiny-verse 4.2.1 build