Skip to content

Commit

Permalink
docs: fix formatting in openair package file
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-davison committed Feb 3, 2025
1 parent 5c6c248 commit 8d3e903
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 73 deletions.
70 changes: 30 additions & 40 deletions R/openair-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
#' dispersion modelling. The availability of meteorological data at the same
#' time resolution greatly enhances the capabilities of these tools.
#'
#' \code{openair} contains collection of functions to analyse air pollution
#' data. Typically it is expected that data are hourly means, although most
#' `openair` contains collection of functions to analyse air pollution data.
#' Typically it is expected that data are hourly means, although most
#' functions consider other time periods. The principal aim to make available
#' analysis techniques that most users of air quality data and model output
#' would not normally have access to. The functions consist of those developed
Expand All @@ -18,67 +18,57 @@
#' 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://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'.
#' discussed in the manual (available in the `openair` book at
#' <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 `Date`
#' or `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
#' for finer control and perhaps more in-depth analysis.
#'
#' The \code{openair} package depends on several other packages written by
#' other people to function properly.
#'
#' 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://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
#' and issue a warning if TRUE. It is recommended that data are expressed in
#' UTC/GMT (or a fixed offset from) to avoid potential problems with R and
#' \code{openair} functions. The \code{openair} manual provides advice on
#' these issues (available on the website).
#' `openair` functions. The `openair` book provides advice on these issues
#' (available on the website).
#'
#' To check to see if \code{openair} has been correctly installed, try some of
#' the examples below.
#' To check to see if `openair` has been correctly installed, try some of the
#' examples below.
#'
#' @section The \code{openair} class:
#' @section The `openair` class:
#'
#' As well as generating the plots themselves, \code{openair} plotting
#' functions also return an object of class ``openair''. The object includes
#' three main components:
#' As well as generating the plots themselves, `openair` plotting functions
#' also return an object of class `"openair"`. The object includes three main
#' components:
#'
#' - \code{call}, the command used to generate the plot.
#' - `call`, the command used to generate the plot.
#'
#' - \code{data}, the data frame of summarised information used to make the
#' - `data`, the data frame of summarised information used to make the
#' plot.
#'
#' - \code{plot}, the plot itself.
#' - `plot`, the plot itself.
#'
#' If retained, e.g., using \code{output <- polarPlot(mydata, "nox")}, this
#' output can be used to recover the data, reproduce or rework the original
#' plot or undertake further analysis.
#' If retained, e.g., using `output <- polarPlot(mydata, "nox")`, this output
#' can be used to recover the data, reproduce or rework the original plot or
#' undertake further analysis.
#'
#' An openair output can be manipulated using a number of generic operations,
#' including \code{print}, \code{plot} and \code{summary}. The examples below
#' An `openair` output can be manipulated using a number of generic
#' operations, including `print`, `plot` and `summary`. The examples below
#' show some examples of using an `openair` object.
#'
#' @references Most reference details are given under the specific functions.
#' The principal reference is below but users may also wish to cite the manual
#' (details for doing this are contained in the manual itself).
#' The principal reference is below.
#'
#' Carslaw, D.C. and K. Ropkins, (2012) openair --- an R package for air
#' quality data analysis. Environmental Modelling & Software. Volume 27-28,
#' 52-61.
#' - Carslaw, D.C. and K. Ropkins, (2012) openair --- an R package for
#' air quality data analysis. Environmental Modelling & Software.
#' Volume 27-28, 52-61.
#'
#' @seealso See \url{https://openair-project.github.io/openair/} for up to date
#' @seealso See <https://openair-project.github.io/openair/> for up to date
#' information on the project, and the openair book
#' (\url{https://openair-project.github.io/book/}) for thorough
#' documentation and examples.
#' (<https://openair-project.github.io/book/>) for thorough documentation and
#' examples.
#'
#' @examples
#' \dontrun{
Expand Down
59 changes: 26 additions & 33 deletions man/openair-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8d3e903

Please sign in to comment.