https://github.com/davidcarslaw/openairmaps

mapping functions to support openair
https://github.com/davidcarslaw/openairmaps

Last synced: about 2 months ago
JSON representation

mapping functions to support openair

• Host: GitHub
• URL: https://github.com/davidcarslaw/openairmaps
• Owner: davidcarslaw
• License: gpl-3.0
• Created: 2016-11-10T15:55:45.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T07:19:45.000Z (3 months ago)
• Last Synced: 2024-04-15T08:49:58.522Z (3 months ago)
• Language: R
• Homepage: https://davidcarslaw.github.io/openairmaps/
• Size: 18.9 MB
• Stars: 18
• Watchers: 9
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Lists

• open-sustainable-technology - openairmaps - Combine the robust analytical methods found in openair with the highly capable leaflet package. (Natural Resources / Air Quality)
• awesome-air-quality - openairmaps - _mapping functions to support openair_ [CRAN](https://cran.r-project.org/web/packages/openairmaps/index.html) (Software Libraries)

README

        
---

output: github_document

editor_options: 

  chunk_output_type: console

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# openairmaps: tools to create maps of air pollution data 

[![R-CMD-check](https://github.com/davidcarslaw/openairmaps/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/davidcarslaw/openairmaps/actions/workflows/R-CMD-check.yaml)

[![CRAN status](https://www.r-pkg.org/badges/version/openairmaps)](https://CRAN.R-project.org/package=openairmaps)

The main goal of `{openairmaps}` is to combine the robust analytical methods found in [openair](https://davidcarslaw.github.io/openair/) with the highly capable `{leaflet}` package. `{openairmaps}` is thoroughly documented in the [openair book](https://bookdown.org/david_carslaw/openair/sections/maps/maps-overview.html).

## Installation

You can install the release version of `{openairmaps}` from CRAN with:

``` r

install.packages("openairmaps")

```

You can install the development version of `{openairmaps}` from GitHub with:

``` r

# install.packages("pak")

pak::pak("davidcarslaw/openairmaps")

```

## Overview

```{r loadpkg}

library(openairmaps)

```

The `openairmaps` package is thoroughly documented in the [openair book](https://bookdown.org/david_carslaw/openair/sections/maps/maps-overview.html), which goes into great detail about its various functions. Functionality includes visualising UK AQ networks (`networkMap()`), putting "polar directional markers" on maps (e.g., `polarMap()`) and overlaying HYSPLIT trajectories on maps (e.g., `trajMap()`), all using the `{leaflet}` package.

```{r eg, eval = FALSE}

polar_data %>%

  openair::cutData("daylight") %>%

  buildPopup(

    c("site", "site_type"),

    names = c("Site" = "site", "Site Type" = "site_type"),

    control = "daylight"

  ) %>%

  polarMap(

    pollutant = "no2",

    limits = c(0, 180),

    control = "daylight",

    popup = "popup"

  )

```

```{r egreal, echo = FALSE, fig.cap="An example `polarMap()` showing NO2 concentrations in central London.", fig.alt="A screenshot of a leaflet map. It shows an OpenStreetMap map layer, overlaid with bivariate polar plots. Polar plots are visualisations on polar coordinates with wind direction on the spoke axes, wind speed on the radial axes, and a smooth surface showing pollutant concentrations. A menu is found at the top-right of the map, which allows users to swap between daylight and nighttime observations."}

knitr::include_graphics("man/figures/README-examplemap.png")

```

While an interactive map is preferred for exploratory directional analysis, it is limited to the HTML format. Some applications (for example, academic journals) demand "static" formats like .docx and .pdf. For this reason, "static" versions of `{openairmaps}` polar marker functions have been provided which are written in `{ggplot2}`. A benefit of being written in `{ggplot2}` is that additional layers can be added (e.g., `geom_label()` could be used to label sites) and limited further customisation is available using `theme()` and `guides()`.

Static maps require users to provide a [ggmap](https://github.com/dkahle/ggmap) tileset, which at the time of writing requires an API key for either Google or Stadia Maps.