CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <title>Tools for the Analysis of Air Pollution Data • openair</title> <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png"> <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png"> <link rel="apple-touch-icon" type="image/png" sizes="180x180" href="apple-touch-icon.png"> <link rel="apple-touch-icon" type="image/png" sizes="120x120" href="apple-touch-icon-120x120.png"> <link rel="apple-touch-icon" type="image/png" sizes="76x76" href="apple-touch-icon-76x76.png"> <link rel="apple-touch-icon" type="image/png" sizes="60x60" href="apple-touch-icon-60x60.png"> <script src="deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <link href="deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"> <script src="deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"> <link href="deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"> <script src="deps/headroom-0.11.0/headroom.min.js"></script><script src="deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="deps/search-1.0.0/fuse.min.js"></script><script src="deps/search-1.0.0/mark.min.js"></script><script src="pkgdown.js"></script><meta property="og:title" content="Tools for the Analysis of Air Pollution Data"> <meta name="description" content="Tools to analyse, interpret and understand air pollution data. Data are typically regular time series and air quality measurement, meteorological data and dispersion model output can be analysed. The package is described in Carslaw and Ropkins (2012, <doi:10.1016/j.envsoft.2011.09.008>) and subsequent papers."> <meta property="og:description" content="Tools to analyse, interpret and understand air pollution data. Data are typically regular time series and air quality measurement, meteorological data and dispersion model output can be analysed. The package is described in Carslaw and Ropkins (2012, <doi:10.1016/j.envsoft.2011.09.008>) and subsequent papers."> <meta property="og:image" content="https://davidcarslaw.github.io/openair/logo.png"> </head> <body> <a href="#main" class="visually-hidden-focusable">Skip to contents</a> <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container"> <a class="navbar-brand me-2" href="index.html">openair</a> <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">2.18.2.9004</small> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <div id="navbar" class="collapse navbar-collapse ms-3"> <ul class="navbar-nav me-auto"> <li class="nav-item"><a class="nav-link" href="articles/openair.html">Get started</a></li> <li class="nav-item"><a class="nav-link" href="reference/index.html">Functions</a></li> <li class="nav-item"><a class="nav-link" href="news/index.html">News</a></li> <li class="nav-item"><a class="external-link nav-link" href="https://bookdown.org/david_carslaw/openair/">Book (external)</a></li> </ul> <ul class="navbar-nav"> <li class="nav-item"><form class="form-inline" role="search"> <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="search.json"> </form></li> <li class="nav-item"><a class="external-link nav-link" href="https://github.com/davidcarslaw/openair/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li> </ul> </div> </div> </nav><div class="container template-home"> <div class="row"> <main id="main" class="col-md-9"><div align="center"> <p><img src="reference/figures/logo.png" height="200"></p> <div class="section level2"> <h2 id="openair"> <strong>openair</strong><a class="anchor" aria-label="anchor" href="#openair"></a> </h2> <div class="section level3"> <h3 id="open-source-tools-for-air-quality-data-analysis">open source tools for air quality data analysis<a class="anchor" aria-label="anchor" href="#open-source-tools-for-air-quality-data-analysis"></a> </h3>  </div> </div> </div> <p><strong>openair</strong> is an R package developed for the purpose of analysing air quality data — or more generally atmospheric composition data. The package is extensively used in academia, the public and private sectors. The project was initially funded by the UK Natural Environment Research Council (<a href="https://www.ukri.org/councils/nerc/" class="external-link">NERC</a>), with additional funds from the UK Department for Environment Food & Rural Affairs (<a href="https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs" class="external-link">Defra</a>).</p> <div align="center"> <p><em>Part of the openair toolkit</em></p> <p><a href="https://davidcarslaw.github.io/openair/"><img src="https://img.shields.io/badge/openair_core-06D6A0?style=flat-square" alt="openair"></a> | <a href="https://davidcarslaw.github.io/worldmet/" class="external-link"><img src="https://img.shields.io/badge/worldmet-26547C?style=flat-square" alt="worldmet"></a> | <a href="https://davidcarslaw.github.io/openairmaps/"><img src="https://img.shields.io/badge/openairmaps-FFD166?style=flat-square" alt="openairmaps"></a> | <a href="https://davidcarslaw.github.io/deweather/" class="external-link"><img src="https://img.shields.io/badge/deweather-EF476F?style=flat-square" alt="deweather"></a></p> </div> <hr> <div class="section level2"> <h2 id="id_-core-features">💡 Core Features<a class="anchor" aria-label="anchor" href="#id_-core-features"></a> </h2> <p><strong>openair</strong> has developed over many years to form an extensive toolkit of functions for analysing air quality and atmospheric composition data.</p> <ul> <li><p><strong>Access to data</strong> from several hundred UK air pollution monitoring sites through the <code><a href="reference/importUKAQ.html">importUKAQ()</a></code> family of functions.</p></li> <li><p><strong>Time Series & Trend analysis</strong> to explore how air quality concentrations vary over time (e.g., through <code><a href="reference/timePlot.html">timePlot()</a></code>, <code><a href="reference/timeVariation.html">timeVariation()</a></code>, and <code><a href="reference/calendarPlot.html">calendarPlot()</a></code>).</p></li> <li><p><strong>Directional analysis</strong> to help characterise different sources of pollution, including the creation of <strong>bivariate polar plots</strong> using <code><a href="reference/polarPlot.html">polarPlot()</a></code>.</p></li> <li><p><strong>Trajectory analysis</strong> to examine NOAA Hysplit trajectories, with plotting (<code><a href="reference/trajPlot.html">trajPlot()</a></code>), heatmap (<code><a href="reference/trajLevel.html">trajLevel()</a></code>) and clustering (<code><a href="reference/trajCluster.html">trajCluster()</a></code>) functionality.</p></li> <li><p><strong>Utility functions</strong>, such as <code><a href="reference/timeAverage.html">timeAverage()</a></code> and <code><a href="reference/selectByDate.html">selectByDate()</a></code> to make it easier to manipulate atmospheric composition data.</p></li> <li><p><strong>Flexible plot conditioning</strong> to easily plot data by hour or the day, day of the week, season of the year, etc., through the <code>type</code> option available in most functions.</p></li> </ul> <div align="center"> <p><img src="reference/figures/feature-banner.png" width="800"></p> </div> <hr> </div> <div class="section level2"> <h2 id="id_-documentation">📖 Documentation<a class="anchor" aria-label="anchor" href="#id_-documentation"></a> </h2> <p>All <strong>openair</strong> functions are fully documented; access documentation using R in your IDE of choice.</p> <div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> <code class="sourceCode R"><span><span class="op">?</span><span class="fu">openair</span><span class="fu">::</span><span class="va"><a href="reference/polarPlot.html">polarPlot</a></span></span></code></pre></div> <p>Documentation is also hosted online on the <strong>package website</strong>.</p> <p><a href="https://davidcarslaw.github.io/openair/"><img src="https://img.shields.io/badge/website-documentation-blue" alt="website"></a></p> <p>A guide to the openair toolkit can be found in the <strong>online book</strong>, which contains lots of code snippets, demonstrations of functionality, and ideas for the application of <strong>openair</strong>’s various functions.</p> <p><a href="https://bookdown.org/david_carslaw/openair/" class="external-link"><img src="https://img.shields.io/badge/book-code_demos_and_ideas-blue" alt="book"></a></p> <hr> </div> <div class="section level2"> <h2 id="id_️-installation">🗃️ Installation<a class="anchor" aria-label="anchor" href="#id_%EF%B8%8F-installation"></a> </h2> <p><strong>openair</strong> can be installed from <strong>CRAN</strong> with:</p> <div class="sourceCode" id="cb2"><pre class="downlit sourceCode r"> <code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"openair"</span><span class="op">)</span></span></code></pre></div> <p>You can also install the development version of <strong>openair</strong> from GitHub using <a href="https://pak.r-lib.org/" class="external-link">pak</a>:</p> <div class="sourceCode" id="cb3"><pre class="downlit sourceCode r"> <code class="sourceCode R"><span><span class="co"># install.packages("pak")</span></span> <span><span class="fu">pak</span><span class="fu">::</span><span class="fu"><a href="https://pak.r-lib.org/reference/pak.html" class="external-link">pak</a></span><span class="op">(</span><span class="st">"davidcarslaw/openair"</span><span class="op">)</span></span></code></pre></div> <hr> <p>🏛️ <strong>openair</strong> is primarily maintained by <a href="https://github.com/davidcarslaw" class="external-link">David Carslaw</a>.</p> <p>📃 <strong>openair</strong> is licensed under the <a href="https://davidcarslaw.github.io/openair/LICENSE.html">GNU General Public License</a>.</p> <p>🧑‍💻 Contributions are welcome from the wider community. See the <a href="https://davidcarslaw.github.io/openair/CONTRIBUTING.html">contributing guide</a> and <a href="https://davidcarslaw.github.io/openair/CODE_OF_CONDUCT.html">code of conduct</a> for more information.</p> </div> </main><aside class="col-md-3"><div class="links"> <h2 data-toc-skip>Links</h2> <ul class="list-unstyled"> <li><a href="https://cloud.r-project.org/package=openair" class="external-link">View on CRAN</a></li> <li><a href="https://github.com/davidcarslaw/openair/" class="external-link">Browse source code</a></li> <li><a href="https://github.com/davidcarslaw/openair/issues" class="external-link">Report a bug</a></li> </ul> </div> <div class="license"> <h2 data-toc-skip>License</h2> <ul class="list-unstyled"> <li><a href="LICENSE.html">Full license</a></li> <li><small>GPL (>= 2)</small></li> </ul> </div> <div class="community"> <h2 data-toc-skip>Community</h2> <ul class="list-unstyled"> <li><a href="CONTRIBUTING.html">Contributing guide</a></li> <li><a href="CODE_OF_CONDUCT.html">Code of conduct</a></li> </ul> </div> <div class="citation"> <h2 data-toc-skip>Citation</h2> <ul class="list-unstyled"> <li><a href="authors.html#citation">Citing openair</a></li> </ul> </div> <div class="developers"> <h2 data-toc-skip>Developers</h2> <ul class="list-unstyled"> <li>David Carslaw <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0003-0991-950X" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li> <li>Jack Davison <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0003-2653-6615" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li> <li>Karl Ropkins <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-0294-6997" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li> </ul> </div> <div class="dev-status"> <h2 data-toc-skip>Dev status</h2> <ul class="list-unstyled"> <li><a href="https://github.com/davidcarslaw/openair/actions" class="external-link"><img src="https://github.com/davidcarslaw/openair/workflows/R-CMD-check/badge.svg" alt="R-CMD-check"></a></li> <li><a href="https://CRAN.R-project.org/package=openair" class="external-link"><img src="https://www.r-pkg.org/badges/version/openair" alt="CRAN status"></a></li> <li><a href="https://cran.r-project.org/package=openair" class="external-link"><img src="https://cranlogs.r-pkg.org/badges/grand-total/openair" alt="metacran downloads"></a></li> <li><a href="https://github.com/davidcarslaw/openair" class="external-link"><img src="https://img.shields.io/badge/CODE-github-black?logo=github" alt="github"></a></li> <li><a href="https://davidcarslaw.github.io/openair/"><img src="https://img.shields.io/badge/DOCS-website-black" alt="website"></a></li> <li><a href="https://bookdown.org/david_carslaw/openair/" class="external-link"><img src="https://img.shields.io/badge/DOCS-book-black" alt="book"></a></li> </ul> </div> </aside> </div> <footer><div class="pkgdown-footer-left"> <p>Developed by David Carslaw, Jack Davison, Karl Ropkins.</p> </div> <div class="pkgdown-footer-right"> <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p> </div> </footer> </div> </body> </html>