https://github.com/davidcarslaw/openairmaps

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

Last synced: 14 days 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 (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T08:29:26.000Z (5 months ago)
• Last Synced: 2024-06-11T17:06:24.696Z (5 months ago)
• Language: R
• Homepage: https://davidcarslaw.github.io/openairmaps/
• Size: 62.5 MB
• Stars: 19
• Watchers: 9
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

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

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%",

  message = FALSE,

  warning = FALSE

)

```

# 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/) on a range of dynamic and static maps. Core 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. Static equivalents of most functions are also available for insertion into traditional reports and academic articles.

## 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")

```

## Documentation

All functions in `{openairmaps}` are thoroughly documented. The [openairmaps website](https://davidcarslaw.github.io/openairmaps/) contains all documentation and a change log of new features. There are also many examples of `{openairmaps}` functionality the [openair book](https://bookdown.org/david_carslaw/openair/sections/maps/maps-overview.html), which goes into great detail about its various functions.

```{r graphic, echo=FALSE, fig.alt="An assembly of openairmaps maps, all of which are screenshots of dynamic leaflet maps. Top right: bivaraite polar plots. Bottom right: HYSPLIT trajectories. Right: markers displaying the locations of UK AURN sites."}

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

```

## The `{openair}` toolkit

-   [`{openair}`](https://davidcarslaw.github.io/openair/): Import, analyse, and visualise air quality and atmospheric composition data.

-   [`{worldmet}`](https://davidcarslaw.github.io/worldmet/): Access world meteorological data from NOAA's Integrated Surface Database.

-   [`{openairmaps}`](https://davidcarslaw.github.io/openairmaps/): Visualise air quality data on interactive and static maps.

-   [`{deweather}`](https://davidcarslaw.github.io/deweather/): Use machine learning to remove the effects of meteorology on air quality time series.