mmaqshiny v1.0

mmaqshiny v1.0: R-Shiny package to explore Air-Quality Mobile-Monitoring data - Published in JOSS (2020)

https://github.com/meenakshi-kushwaha/mmaqshiny

Science Score: 93.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Economics Social Sciences - 40% confidence
Political Science Social Sciences - 40% confidence
Last synced: 6 months ago · JSON representation

Repository

R-Shiny package to explore Air-Pollution Mobile Monitoring data

Basic Info
  • Host: GitHub
  • Owner: meenakshi-kushwaha
  • License: other
  • Language: R
  • Default Branch: master
  • Size: 15.7 MB
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 3
  • Open Issues: 0
  • Releases: 0
Created almost 6 years ago · Last pushed almost 4 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

mmaqshiny v1.1: R package to explore air quality mobile monitoring data

status DOI R-CMD-check

2021-10-19: Add in's for v1.1!! - Added two new instruments DustTrak 8533 and Equinox RH sensor. - All codes now changed to functional programs.

2021-01-04: Add in's!! - Added qq plot and density plot.

2020-09-23: Bug fixes!! - Changed the code to tidy version! Usage of reactive elements and joined table preview (removed repeated code of joining and manipulation). - Fixed shinyjs update, shifting from XML to xml2 happening soon!

Summary

mmaqshiny is for analysing, visualising and spatial plotting of high-resolution air quality data collected by specific devices installed on a moving platform. With the click of a button, the app generates: summary statistics, time series plots and spatial map of pollutant concentrations. This app reduces the time consumed for analysing each pollutant individually. It helps check the quality of the data at near real time (same day) and instantly visualise pollution hotspots. The time series plots of each pollutant help in understanding the temporal patterns of concentrations and performance of the instruments.

High frequency (1 Hz) data of PM2.5 (mass concentrations of particulate matter with size less than 2.5 microns), Black carbon mass concentrations (BC), ultra-fine particle number concentrations, carbon-di-oxide (CO2) along with GPS coordinates and relative humidity (RH) data are collected by some popular portable instruments (TSI DustTrak-8530 / 8533, Aethlabs microAeth-AE51, TSI CPC3007, LICOR Li-850, Garmin GPSMAP 64s, Omega USB RH probe and Equinox RH sensor respectively) can be handled by this package. The package incorporates device specific cleaning and correction algorithms. RH correction is applied to DustTrak PM2.5 following a method described in @Chakrabarti:2004. If required, user can also input linear regression coefficients for correcting the PM2.5 data. An example of DustTrak PM2.5 raw and corrected data, using slope = 0.21, intercept = 11.1 is shown below.

| \Uncorrected{fig: `DT8530_PM2.5`} | |:--:| | Uncorrected DT8530_PM2.5 |

| \Corrected{fig: `DT8530_PM2.5_Ref`} | |:--:| | Corrected DT8530_PM2.5_Ref |

The package cleans BC data for the vibration generated noise, by adopting a statistical procedure as explained in @Apte:2011, followed by a loading correction as suggested by @Ban-Weiss:2009. For the ultra-fine particle number concentration data, provision is given for dilution correction factor (if a diluter is used with CPC3007; default value is 1).

The package joins the raw, cleaned and corrected data from the above mentioned instruments and generates a downloadable csv file. It accepts multiple files for each parameter.

The package requires GPS file (.gpx) as a mandatory input along with timezone which can be selected using the dropdown menu (a link to all accepted timezone formats in R is also included). All other pollutant files are optional. A testing data set is provided in the "data" folder inside inst/shiny; with each instrument folder containing 2 days of data.

The example data included here contains with following file names -

  • xxx_Garmin correspond to Garmin GPS location files
  • xxx_AE51 correspond to AE51 BC files
  • xxx_DT8530 correspond to DustTrak 8530 PM2.5 files
  • xxx_DT8533 correspond to DustTrak 8533 PM files
  • xxx_RH correspond to RH files
  • xxx_RH172 correspond to Equinox RH files
  • xxx_CPC3007 correspond to CPC3007 Particle Concentration files
  • xxxLICOR correspond to LI-COR CO2 files

The output is displayed in five different tabs.

1) Joined File displays all cleaned and joined data. 2) Summary displays summary statistics for each parameter. 3) Plots displays interactive time series line plots, density and qq plots for the selected parameter. 4) Map provides a spatial map for the user selected pollutant on an OpenStreetMap basemap. 5) Alarm and Settings tab displays each instrument's settings and alarms (if any).

Limitations

1) It has provision for only linear correction coefficients of PM2.5. 2) It is instrument specific.

Installation

mmaqshiny can be installed from github.

Load and run mmaqshiny as follows:

r install.package("devtools") devtools::install_github("meenakshi-kushwaha/mmaqshiny") mmaqshiny::mmaqshiny_run() A preloaded dataset appears which is a joined file of sample data collected during a mobile monitoring campaign in Bangalore, India.

User Guide

To use the app, follow the steps below.

  1. User needs to add the timezone of data collection. This is a mandatory step. Since all the files are joined using the date time column.

  2. Add .gpx files from GPSMAP64s (location data). NOTE: A warning message will appear if input files are from different dates. This is a mandatory step too, since all the files are joined to GPS file, since mobile monitoring studies are based on location this file is required.

  3. Add pollutant .csv files as downloaded from the instruments (the number of files in each instrument and also the number of different instrument's data available does not matter since the app is capable of handling any number).

  4. User can add slope and intercept if a linear correction is required for the DustTrak measured PM2.5.

\label{fig:example}

  1. User can also input a Dilution factor if diluter is used for CPC-3007. Default value is 1 (no diluter).

  2. Click join button.

  3. Click the download button to download the joined csv file.

\label{fig:example}

\label{fig:example}

  1. Summary tab allows user to check the summary statistics for each of the pollutant.

\label{fig:example}

  1. The Plots tab now allows user to select a parameter to plot time series, density plot and qq plot of all the parameters.

\label{fig:example}

\label{fig:example}

\label{fig:example}

  1. The Map tab visualises interactive maps for spatial visualization of selected pollutant.

\label{fig:example}

\label{fig:example}

  1. Alarms and Settings tab display any status errors during data collection and instrument setting.

\label{fig:example}

Glossary

  • Latitude:Latitude
  • Longitude: Longitude
  • BC: Raw BC data
  • BC_NR: Noise removed BC
  • BC_NR_LC: Noise removed and loading corrected BC
  • PM2.5: Raw PM2.5 from DustTrak 8530
  • PM2.5_RHC: RH corrected PM2.5 from DustTrak 8530
  • PM2.5_RHC_Ref: Reference and RH corrected PM2.5 from DustTrak 8530
  • PM2.5_Ref: Reference corrected PM2.5 from DustTrak 8530
  • PM2.5: Raw PM2.5 from DustTrak 8533
  • PM2.5_RHC: RH corrected PM2.5 from DustTrak 8533
  • PM2.5_RHC_Ref: Reference and RH corrected PM2.5 from DustTrak 8533
  • PM2.5_Ref: Reference corrected PM2.5 from DustTrak 8533
  • Particle Concentration: Dilution corrected ultra-fine particle number concentration
  • CO2: CO2 data

Community guidelines

  1. Contribute to the software

  2. Report issues or problems with the software / Seek Support

  1. Contributors must adhere to the Code of Conduct.

Instrument Description

  1. DustTrak

It utilises the well-established aerosol light scattering technique to estimate the real-time aerosol mass loadings and works at a flow rate of 3 LPM (liters per minute). Detailed specifications can be found here.

  1. microAeth AE51

It is a highly sensitive, palm-held and battery-operated instrument designed for measuring the optically-absorbing BC component of aerosol particles.It measures the rate of change in absorption of transmitted light (880 nm) due to continuous collection of aerosols load on to the filter ticket and has a wide dynamic range of measurement from 0 to 1 mg/m³. More details of AE51 can be found here.

  1. Condensation Particle Counter 3007 (CPC)

It is an alcohol based handheld instrument used to measure ultra-fine particles. It works on the optical detection principle, and operates at a flow rate of 0.7 LPM.The instrument detects and measures the particles in the size range of 10 nm to > 1 µm. More technical details of the instrument can be found here.

  1. LI-COR 850

It is a CO2/H2O gas analyzer which has a measurement range of 0-20,000 ppm and accuracy of 1.5%. For logging the data it requires a laptop with the software called LI-COR. More details can be found here.

  1. Omega RH-USB

It is an instrument used for measuring RH and temperature. It has an accuracy of ±3% for Relative humidity and ±1°C (±1.8°F) for temperature. It requires a software to log the data called TRH central. The frequency of data logging can be changed as per need using this software. For more information click here.

  1. GPSMAP-64s

It works on the ‘trilateration’ mathematical principle of GPS and usually connects to 4 satellites to give the accurate location. More technical details of the instrument can be found here.

Owner

  • Name: Meenakshi Kushwaha
  • Login: meenakshi-kushwaha
  • Kind: user
  • Location: Taipei, Taiwan
  • Company: ILK Labs

Environmental Health| Air Quality| Epidemiology | All things R

JOSS Publication

mmaqshiny v1.0: R-Shiny package to explore Air-Quality Mobile-Monitoring data
Published
June 28, 2020
Volume 5, Issue 50, Page 2250
Authors
Adithi R. Upadhya ORCID
ILK Labs, Bengaluru, India
Pratyush Agrawal
ILK Labs, Bengaluru, India
Sreekanth Vakacherla ORCID
Center for Study of Science, Technology & Policy, Bengaluru, India
Meenakshi Kushwaha
ILK Labs, Bengaluru, India
Editor
Arfon Smith ORCID
Tags
mobile-monitoring air quality shiny

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 218
  • Total Committers: 3
  • Avg Commits per committer: 72.667
  • Development Distribution Score (DDS): 0.096
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
adithirgis a****i@i****m 197
meenakshi-kushwaha m****a@g****m 19
Arfon Smith a****n 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 2
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 8 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 3.5
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • 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
Top Authors
Issue Authors
  • ibarraespinosa (1)
  • nistara (1)
Pull Request Authors
  • arfon (1)
  • meenakshi-kushwaha (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 243 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: mmaqshiny

Explore Air-Quality Mobile-Monitoring Data

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 243 Last month
Rankings
Forks count: 17.8%
Stargazers count: 22.5%
Dependent packages count: 29.8%
Average: 31.9%
Dependent repos count: 35.5%
Downloads: 54.1%
Maintainers (1)
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • Cairo >= 1.5.12.2 imports
  • DT >= 0.17 imports
  • XML >= 3.99.0.6 imports
  • caTools >= 1.18.2 imports
  • data.table >= 1.14.0 imports
  • dplyr >= 1.0.5 imports
  • ggplot2 >= 3.3.3 imports
  • htmltools >= 0.5.1.1 imports
  • leaflet >= 2.0.4.1 imports
  • lubridate >= 1.7.10 imports
  • plotly >= 4.9.3 imports
  • shiny >= 1.6.0 imports
  • shinyjs >= 2.0.0 imports
  • tidyverse >= 1.3.0 imports
  • xts >= 0.12.1 imports
  • zoo >= 1.8.9 imports
  • devtools >= 2.4.0 suggests
  • shinytest >= 1.5.0 suggests
  • testthat >= 3.0.2 suggests
  • usethis >= 2.0.1 suggests