A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

rdefra

Interact with the UK AIR Pollution Database from DEFRA.
https://github.com/ropensci-archive/rdefra

Category: Natural Resources
Sub Category: Air Quality

Keywords

air-pollution air-pollution-levels air-quality defra peer-reviewed r r-package rstats uk

Keywords from Contributors

geocode genome routes occurrences cycle directed-graph ecology noaa species biodiversity

Last synced: about 15 hours ago
JSON representation

Repository metadata

rdefra: Interact with the UK AIR Pollution Database from DEFRA

README-not.md

rdefra: Interact with the UK AIR Pollution Database from DEFRA

DOI
JOSS

R-CMD-check
codecov.io
CRAN Status Badge
CRAN Total Downloads
CRAN Monthly Downloads

The package rdefra allows
to retrieve air pollution data from the Air Information Resource
UK-AIR of the Department for
Environment, Food and Rural Affairs in the United Kingdom. UK-AIR does
not provide a public API for programmatic access to data, therefore this
package scrapes the HTML pages to get relevant information.

This package follows a logic similar to other packages such as
waterData and
rnrfa: sites are first
identified through a catalogue, data are imported via the station
identification number, then data are visualised and/or used in analyses.
The metadata related to the monitoring stations are accessible through
the function ukair_catalogue(), missing stations’ coordinates can be
obtained using the function ukair_get_coordinates(), and time series
data related to different pollutants can be obtained using the function
ukair_get_hourly_data().

DEFRA’s servers can handle multiple data requests, therefore concurrent
calls can be sent simultaneously using the
parallel package. Although the limit rate
depends on the maximum number of concurrent calls, traffic and available
infrastructure, data retrieval is very efficient. Multiple years of data
for hundreds of sites can be downloaded in only few minutes.

For similar functionalities see also the
openair package, which
relies on a local copy of the data on servers at King’s College (UK),
and the ropenaq which
provides UK-AIR latest measured levels (see
https://uk-air.defra.gov.uk/latest/currentlevels) as well as data from
other countries.

Installation

Get the released version from CRAN:

install.packages("rdefra")

Or the development version from GitHub using the package remotes:

install.packages("remotes")
remotes::install_github("ropensci/rdefra")

Load the rdefra package:

library(rdefra)

Functions

The package logic assumes that users access the UK-AIR database in the
following steps:

  1. Browse the catalogue of available stations and selects some stations
    of interest (see function ukair_catalogue()).
  2. Get missing coordinates (see function ukair_get_coordinates()).
  3. Retrieves data for the selected stations (see functions
    ukair_get_site_id() and ukair_get_hourly_data()).

For an in-depth description of the various functionalities and example
applications, please refer to the package
vignette.

Meta

  • This package and functions herein are part of an experimental open-source project. They are provided as is, without any guarantee.
  • Please report any issues or
    bugs
    .
  • License: GPL-3
  • This package was reviewed by Maëlle
    Salmon
    and Hao
    Zhu
    for submission to ROpenSci (see
    review here) and
    the Journal of Open Source Software (see review
    here).
  • Cite rdefra: citation(package = "rdefra")

ropensci_footer


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 214
Total Committers: 7
Avg Commits per committer: 30.571
Development Distribution Score (DDS): 0.042

Commits in past year: 3
Committers in past year: 1
Avg Commits per committer in past year: 3.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Claudia Vitolo c****o@g****m 205
Maëlle Salmon m****n@y****e 3
olivroy 5****y 2
cherylisabella c****a@g****m 1
Karthik Ram k****m@g****m 1
Jeroen Ooms j****s@g****m 1
rOpenSci Bot m****t@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 16
Total pull requests: 4
Average time to close issues: 6 months
Average time to close pull requests: 3 days
Total issue authors: 8
Total pull request authors: 4
Average comments per issue: 2.88
Average comments per pull request: 2.5
Merged pull request: 4
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: about 8 hours
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ropensci-archive/rdefra

Top Issue Authors

  • maelle (6)
  • cvitolo (3)
  • sebsfox (2)
  • grahamrp (1)
  • rsbivand (1)
  • sckott (1)
  • jeroen (1)
  • haozhu233 (1)

Top Pull Request Authors

  • maelle (1)
  • karthik (1)
  • cherylisabella (1)
  • olivroy (1)

Top Issue Labels

  • help wanted (1)

Top Pull Request Labels


Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • curl * imports
  • dplyr * imports
  • httr * imports
  • lubridate * imports
  • rgdal * imports
  • sf * imports
  • tibble * imports
  • xml2 * imports
  • ggplot2 * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests
  • zoo * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/lint.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/test-coverage.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite

Score: 4.890349128221754