diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 74f71c91..3ed8ae72 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,7 +16,7 @@ If you’ve found a bug, please file an issue that illustrates the bug with a mi ### Pull request process -* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("davidcarslaw/openair", fork = TRUE)`. +* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("openair-project/openair", fork = TRUE)`. * Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index cfcd1124..bd030309 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,7 +8,7 @@ body: value: | Thank you for helping with the development of `{openair}` by reporting a bug. - If you haven't already, you might find it useful to read our [getting help guide](https://bookdown.org/david_carslaw/openair/sections/appendices/appendix-gethelp.html), which details how you can best help us help you! + If you haven't already, you might find it useful to read our [getting help guide](https://openair-project.github.io/book/sections/appendices/appendix-gethelp.html), which details how you can best help us help you! - type: textarea attributes: @@ -23,7 +23,7 @@ body: label: Steps to reproduce description: | Tell us how to reproduce this bug. - Please include a [minimal, fully reproducible example](https://bookdown.org/david_carslaw/openair/sections/appendices/appendix-gethelp.html#sec-reprex), ideally including code. + Please include a [minimal, fully reproducible example](https://openair-project.github.io/book/sections/appendices/appendix-gethelp.html#sec-reprex), ideally including code. If you need to attach data, you can do so in a reply to your issue after it has been submitted. placeholder: | When providing code, please contain it within code chunks using the below formatting: @@ -47,4 +47,4 @@ body: - type: markdown attributes: value: "_Thank you for submitting this bug report!_" - \ No newline at end of file + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f53eec6f..ab75ba70 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - name: openair book - url: https://bookdown.org/david_carslaw/openair/ - about: Before you submit your issue, check to see if your answer is already in the openair book! \ No newline at end of file + url: https://openair-project.github.io/book/ + about: Before you submit your issue, check to see if your answer is already in the openair book! diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 64b9e0af..618d9509 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -8,7 +8,7 @@ body: value: | Thank you for helping with the development of `{openair}` by requesting a new feature. - Before you submit your issue, it may be useful to check through the [openair book](https://bookdown.org/david_carslaw/openair/) just to make sure your suggestion can't already be achieved! + Before you submit your issue, it may be useful to check through the [openair book](https://openair-project.github.io/book/) just to make sure your suggestion can't already be achieved! - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index a107f61c..4e7b0b73 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -8,7 +8,7 @@ body: value: | This is a place to ask a question about `openair`. This could be about how to properly use `openair` functions, interpret plots, or something else entirely. - Before you submit your issue, it may be useful to check through the [openair book](https://bookdown.org/david_carslaw/openair/) just to make sure your question hasn't already been answered! + Before you submit your issue, it may be useful to check through the [openair book](https://openair-project.github.io/book/) just to make sure your question hasn't already been answered! - type: textarea attributes: diff --git a/DESCRIPTION b/DESCRIPTION index 4fbb8d0a..2e61c4fd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -18,9 +18,9 @@ Description: Tools to analyse, interpret and understand air pollution analysed. The package is described in Carslaw and Ropkins (2012, ) and subsequent papers. License: GPL (>= 2) -URL: https://davidcarslaw.github.io/openair/, - https://github.com/davidcarslaw/openair -BugReports: https://github.com/davidcarslaw/openair/issues +URL: https://openair-project.github.io/openair/, + https://github.com/openair-project/openair +BugReports: https://github.com/openair-project/openair/issues Depends: R (>= 3.2.0) Imports: diff --git a/NEWS.md b/NEWS.md index 2fabfe38..790bfb59 100644 --- a/NEWS.md +++ b/NEWS.md @@ -195,7 +195,7 @@ - add option to `TaylorDiagram` for annotation of observed data. - fix issue with `timevariation` when `difference = TRUE` - fix `trajCluster` issue to do with `dplyr` -- access other time-averaged air quality data using `importAURN`, `importSAQN`, `importWAQN`, `importAQE` and `importNI`. New option `data_type`, which can be "hourly" (default), "annual", "monthly", "daily" and "15min" (for SO~2~). These new data sources should make it much easier to work with long-term time series with many sites. See [the openair manual](https://bookdown.org/david_carslaw/openair/sections/data-access/UK-air-quality-data.html) for more details. +- access other time-averaged air quality data using `importAURN`, `importSAQN`, `importWAQN`, `importAQE` and `importNI`. New option `data_type`, which can be "hourly" (default), "annual", "monthly", "daily" and "15min" (for SO~2~). These new data sources should make it much easier to work with long-term time series with many sites. See [the openair manual](https://openair-project.github.io/book/sections/data-access/UK-air-quality-data.html) for more details. - fix terrible spelling in `selectRunning`. # openair 2.8-6 @@ -382,7 +382,7 @@ - fix issue with `type` when used with `timeProp` - fix bias correction when not default type in `windRose` - fix pch colour bug in `timePlot` -- add option `alpha` to `polarPlot` to control transparency of plotted surface. Mostly useful for overlaying polar plots on leaflet maps (see [openairmaps](https://github.com/davidcarslaw/openairmaps) package) +- add option `alpha` to `polarPlot` to control transparency of plotted surface. Mostly useful for overlaying polar plots on leaflet maps (see [openairmaps](https://github.com/openair-project/openairmaps) package) - enhance `grid.line` option in `windRose` so that users can control grid spacing, line type and line colour # openair 1.9-9 diff --git a/R/calcFno2.R b/R/calcFno2.R index f8b5b4e2..62f6b830 100644 --- a/R/calcFno2.R +++ b/R/calcFno2.R @@ -19,8 +19,6 @@ #' formed through these two processes by seeking the optimum level of primary #' NO2 that gives the least error. #' -#' Test data is provided at \url{https://davidcarslaw.github.io/openair/}. -#' #' @param input A data frame with the following fields. \code{nox} and\code{no2} #' (roadside NOX and NO2 concentrations), \code{back_nox}, \code{back_no2} and #' \code{back_o3} (hourly background concentrations of each pollutant). In diff --git a/R/openair-package.R b/R/openair-package.R index eacfb90d..4740996d 100644 --- a/R/openair-package.R +++ b/R/openair-package.R @@ -19,7 +19,7 @@ #' #' The package has a number of requirements for input data and these are #' discussed in the manual (available on the \code{openair} website at -#' \url{https://davidcarslaw.github.io/openair/}). The key requirements are +#' \url{https://openair-project.github.io/openair/}). The key requirements are #' that a date or date-time field must have the name `date' (and can be #' \code{Date} or \code{POSIXct} format), that wind speed is represented as #' `ws' and that wind direction is `wd'. @@ -34,7 +34,7 @@ #' installed, and this requires a connection to the internet. Other packages #' required come with the R base system. If there are problems with the #' automatic download of these packages, see -#' \url{https://davidcarslaw.github.io/openair/} for more details. +#' \url{https://openair-project.github.io/openair/} for more details. #' #' NOTE: openair assumes that data are not expressed in local time where #' 'Daylight Saving Time' is used. All functions check that this is the case @@ -75,9 +75,9 @@ #' quality data analysis. Environmental Modelling & Software. Volume 27-28, #' 52-61. #' -#' @seealso See \url{https://davidcarslaw.github.io/openair/} for up to date +#' @seealso See \url{https://openair-project.github.io/openair/} for up to date #' information on the project, and the openair book -#' (\url{https://bookdown.org/david_carslaw/openair/}) for thorough +#' (\url{https://openair-project.github.io/book/}) for thorough #' documentation and examples. #' #' @examples diff --git a/README.md b/README.md index f155ea97..7a74f04f 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,14 @@ ### open source tools for air quality data analysis -[![R-CMD-check](https://github.com/davidcarslaw/openair/workflows/R-CMD-check/badge.svg)](https://github.com/davidcarslaw/openair/actions) +[![R-CMD-check](https://github.com/openair-project/openair/workflows/R-CMD-check/badge.svg)](https://github.com/openair-project/openair/actions) [![CRAN status](https://www.r-pkg.org/badges/version/openair)](https://CRAN.R-project.org/package=openair) [![metacran downloads](https://cranlogs.r-pkg.org/badges/grand-total/openair)](https://cran.r-project.org/package=openair)
-[![github](https://img.shields.io/badge/CODE-github-black?logo=github)](https://github.com/davidcarslaw/openair) -[![website](https://img.shields.io/badge/DOCS-website-black)](https://davidcarslaw.github.io/openair/) -[![book](https://img.shields.io/badge/DOCS-book-black)](https://bookdown.org/david_carslaw/openair/) +[![github](https://img.shields.io/badge/CODE-github-black?logo=github)](https://github.com/openair-project/openair) +[![website](https://img.shields.io/badge/DOCS-website-black)](https://openair-project.github.io/openair/) +[![book](https://img.shields.io/badge/DOCS-book-black)](https://openair-project.github.io/book/) @@ -25,10 +25,10 @@ status](https://www.r-pkg.org/badges/version/openair)](https://CRAN.R-project.or *Part of the openair toolkit* -[![openair](https://img.shields.io/badge/openair_core-06D6A0?style=flat-square)](https://davidcarslaw.github.io/openair/) | -[![worldmet](https://img.shields.io/badge/worldmet-26547C?style=flat-square)](https://davidcarslaw.github.io/worldmet/) | -[![openairmaps](https://img.shields.io/badge/openairmaps-FFD166?style=flat-square)](https://davidcarslaw.github.io/openairmaps/) | -[![deweather](https://img.shields.io/badge/deweather-EF476F?style=flat-square)](https://davidcarslaw.github.io/deweather/) +[![openair](https://img.shields.io/badge/openair_core-06D6A0?style=flat-square)](https://openair-project.github.io/openair/) | +[![worldmet](https://img.shields.io/badge/worldmet-26547C?style=flat-square)](https://openair-project.github.io/worldmet/) | +[![openairmaps](https://img.shields.io/badge/openairmaps-FFD166?style=flat-square)](https://openair-project.github.io/openairmaps/) | +[![deweather](https://img.shields.io/badge/deweather-EF476F?style=flat-square)](https://openair-project.github.io/deweather/) @@ -66,11 +66,11 @@ All **openair** functions are fully documented; access documentation using R in Documentation is also hosted online on the **package website**. -[![website](https://img.shields.io/badge/website-documentation-blue)](https://davidcarslaw.github.io/openair/) +[![website](https://img.shields.io/badge/website-documentation-blue)](https://openair-project.github.io/openair/) A guide to the openair toolkit can be found in the **online book**, which contains lots of code snippets, demonstrations of functionality, and ideas for the application of **openair**'s various functions. -[![book](https://img.shields.io/badge/book-code_demos_and_ideas-blue)](https://bookdown.org/david_carslaw/openair/) +[![book](https://img.shields.io/badge/book-code_demos_and_ideas-blue)](https://openair-project.github.io/book/)
@@ -86,13 +86,13 @@ You can also install the development version of **openair** from GitHub using `{ ``` r # install.packages("pak") -pak::pak("davidcarslaw/openair") +pak::pak("openair-project/openair") ```
🏛️ **openair** is primarily maintained by [David Carslaw](https://github.com/davidcarslaw). -📃 **openair** is licensed under the [GNU General Public License](https://davidcarslaw.github.io/openair/LICENSE.html). +📃 **openair** is licensed under the [GNU General Public License](https://openair-project.github.io/openair/LICENSE.html). -🧑‍💻 Contributions are welcome from the wider community. See the [contributing guide](https://davidcarslaw.github.io/openair/CONTRIBUTING.html) and [code of conduct](https://davidcarslaw.github.io/openair/CODE_OF_CONDUCT.html) for more information. +🧑‍💻 Contributions are welcome from the wider community. See the [contributing guide](https://openair-project.github.io/openair/CONTRIBUTING.html) and [code of conduct](https://openair-project.github.io/openair/CODE_OF_CONDUCT.html) for more information. diff --git a/_pkgdown.yml b/_pkgdown.yml index d7ba2464..531ca30c 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,4 @@ -url: https://davidcarslaw.github.io/openair/ +url: https://openair-project.github.io/openair/ template: bootstrap: 5 bslib: @@ -19,7 +19,7 @@ navbar: href: news/index.html book: text: Book (external) - href: https://bookdown.org/david_carslaw/openair/ + href: https://openair-project.github.io/book/ reference: - title: Data diff --git a/inst/WORDLIST b/inst/WORDLIST index 40d2cf11..58593d8e 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -302,7 +302,6 @@ berlin bgd birm bon -bookdown boston bukit calcFno @@ -502,4 +501,5 @@ scitotenv seq STL UKAQ -windrose \ No newline at end of file +windrose +openair-project \ No newline at end of file diff --git a/man/calcFno2.Rd b/man/calcFno2.Rd index b3549976..1ebd67c7 100644 --- a/man/calcFno2.Rd +++ b/man/calcFno2.Rd @@ -204,8 +204,6 @@ primarily determined by direct emissions of NO2 and the availability of One to react with NO to form NO2. The method aims to quantify the amount of NO2 formed through these two processes by seeking the optimum level of primary NO2 that gives the least error. - -Test data is provided at \url{https://davidcarslaw.github.io/openair/}. } \references{ Clapp, L.J., Jenkin, M.E., 2001. Analysis of the relationship diff --git a/man/openair-package.Rd b/man/openair-package.Rd index 41fd32b8..3dffc6c6 100644 --- a/man/openair-package.Rd +++ b/man/openair-package.Rd @@ -32,7 +32,7 @@ College London (e.g. the LAQN) and the Scottish Air Quality Network (SAQN). The package has a number of requirements for input data and these are discussed in the manual (available on the \code{openair} website at -\url{https://davidcarslaw.github.io/openair/}). The key requirements are +\url{https://openair-project.github.io/openair/}). The key requirements are that a date or date-time field must have the name \verb{date' (and can be \code{Date} or \code{POSIXct} format), that wind speed is represented as }ws' and that wind direction is `wd'. Most functions work in a very straightforward way, but offer many options @@ -45,7 +45,7 @@ To ensure that these other packages are available, they need to be installed, and this requires a connection to the internet. Other packages required come with the R base system. If there are problems with the automatic download of these packages, see -\url{https://davidcarslaw.github.io/openair/} for more details. +\url{https://openair-project.github.io/openair/} for more details. NOTE: openair assumes that data are not expressed in local time where 'Daylight Saving Time' is used. All functions check that this is the case @@ -116,9 +116,9 @@ quality data analysis. Environmental Modelling & Software. Volume 27-28, 52-61. } \seealso{ -See \url{https://davidcarslaw.github.io/openair/} for up to date +See \url{https://openair-project.github.io/openair/} for up to date information on the project, and the openair book -(\url{https://bookdown.org/david_carslaw/openair/}) for thorough +(\url{https://openair-project.github.io/book/}) for thorough documentation and examples. } \author{ diff --git a/vignettes/articles/openair.Rmd b/vignettes/articles/openair.Rmd index 47296fc8..286ba3d7 100644 --- a/vignettes/articles/openair.Rmd +++ b/vignettes/articles/openair.Rmd @@ -9,7 +9,7 @@ knitr::opts_chunk$set( ) ``` -This vignette outlines some core functionality in `{openair}`. For further examples, please see the [online book](https://bookdown.org/david_carslaw/openair/). +This vignette outlines some core functionality in `{openair}`. For further examples, please see the [online book](https://openair-project.github.io/book/). ```{r setup} library(openair) @@ -95,7 +95,7 @@ windRose(mydata, Wind roses summarising the wind conditions at a monitoring station per year, demonstrating the `{openair}` type option. -There are many flavours of bivariate polar plots, as described [here](https://bookdown.org/david_carslaw/openair/sections/directional-analysis/polar-plots.html) that are useful for understanding air pollution sources. +There are many flavours of bivariate polar plots, as described [here](https://openair-project.github.io/book/sections/directional-analysis/polar-plots.html) that are useful for understanding air pollution sources. ```{r polarplot} polarPlot(mydata,