Learn R Programming

openair (version 1.0)

polarAnnulus: Bivariate polarAnnulus plot

Description

Typically plots the concentration of a pollutant by wind direction and as a function of time as an annulus. The function is good for visualising how concentrations of pollutants vary by wind direction and a time period e.g. by month, day of week.

Usage

polarAnnulus(mydata, pollutant = "nox", resolution = "fine",
  local.tz = NULL, period = "hour", type = "default",
  statistic = "mean", percentile = NA, limits = c(0, 100),
  cols = "default", width = "normal", min.bin = 1,
  exclude.missing = TRUE, date.pad = FALSE, force.positive = TRUE,
  k = c(20, 10), normalise = FALSE, key.header = "",
  key.footer = pollutant, key.position = "right", key = TRUE,
  auto.text = TRUE, ...)

Arguments

mydata
A data frame minimally containing date, wd and a pollutant.
pollutant
Mandatory. A pollutant name corresponding to a variable in a data frame should be supplied e.g. pollutant = "nox". There can also be more than one pollutant specified e.g. pollutant = c("nox", "no2"). The main use of using two or
resolution
Two plot resolutions can be set: normal and fine (the default).
local.tz
Should the results be calculated in local time that includes a treatment of daylight savings time (DST)? The default is not to consider DST issues, provided the data were imported without a DST offset. Emissions activity tends to occur at local time e.g.
period
This determines the temporal period to consider. Options are hour (the default, to plot diurnal variations), season to plot variation throughout the year, weekday to plot day of the week variation and
type
type determines how the data are split i.e. conditioned, and then plotted. The default is will produce a single plot using the entire data. Type can be one of the built-in types as detailed in cutData e.g. season
statistic
The statistic that should be applied to each wind speed/direction bin. Can be mean (default), median, max (maximum), frequency. stdev (standard deviation), weight
percentile
If statistic = "percentile" or statistic = "cpf" then percentile is used, expressed from 0 to 100. Note that the percentile value is calculated in the wind speed, wind direction bins. For this reason
limits
Limits for colour scale.
cols
Colours to be used for plotting. Options include default, increment, heat, jet and user defined. For user defined the user can supply a list of colour names recognised by R (type co
width
The width of the annulus; can be normal (the default), thin or fat.
min.bin
The minimum number of points allowed in a wind speed/wind direction bin. The default is 1. A value of two requires at least 2 valid records in each bin an so on; bins with less than 2 valid records are set to NA. Care should be taken when using a value >
exclude.missing
Setting this option to TRUE (the default) removes points from the plot that are too far from the original data. The smoothing routines will produce predictions at points where no data exist i.e. they predict. By removing the points too far fr
date.pad
For type = "trend" (default), date.pad = TRUE will pad-out missing data to the beginning of the first year and the end of the last year. The purpose is to ensure that the trend plot begins and ends at the beginning or end of year
force.positive
The default is TRUE. Sometimes if smoothing data with steep gradients it is possible for predicted values to be negative. force.positive = TRUE ensures that predictions remain postive. This is useful for several reasons. First, w
k
The smoothing value supplied to gam for the temporal and wind direction components, respectively. In some cases e.g. a trend plot with less than 1-year of data the smoothing with the default values may become too noisy and affected more by ou
normalise
If TRUE concentrations are normalised by dividing by their mean value. This is done after fitting the smooth surface. This option is particularly useful if one is interested in the patterns of concentrations for several pollutants on
key.header
Adds additional text/labels to the scale key. For example, passing the options key.header = "header", key.footer = "footer1" adds addition text above and below the scale key. These arguments are passed to drawOpenKey via qu
key.footer
see key.header.
key.position
Location where the scale key is to plotted. Allowed arguments currently include top, right, bottom and left.
key
Fine control of the scale key via drawOpenKey. See drawOpenKey for further details.
auto.text
Either TRUE (default) or FALSE. If TRUE titles and axis labels will automatically try and format pollutant names and units properly e.g. by subscripting the 2 in NO2.
...
Other graphical parameters passed onto lattice:levelplot and cutData. For example, polarAnnulus passes the option hemisphere = "southern" on to cutData to provide southern (rather than defau

Value

  • As well as generating the plot itself, polarAnnulus also returns an object of class ``openair''. The object includes three main components: call, the command used to generate the plot; data, the data frame of summarised information used to make the plot; and plot, the plot itself. If retained, e.g. using output <- polarAnnulus(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 print, plot and summary.

Details

The polarAnnulus function shares many of the properties of the polarPlot. However, polarAnnulus is focussed on displaying information on how concentrations of a pollutant (values of another variable) vary with wind direction and time. Plotting as an annulus helps to reduce compression of information towards the centre of the plot. The circular plot is easy to interpret because wind direction is most easily understood in polar rather than Cartesian coordinates.

The inner part of the annulus represents the earliest time and the outer part of the annulus the latest time. The time dimension can be shown in many ways including "trend", "hour" (hour or day), "season" (month of the year) and "weekday" (day of the week). Taking hour as an example, the plot will show how concentrations vary by hour of the day and wind direction. Such plots can be very useful for understanding how different source influences affect a location.

For type = "trend" the amount of smoothing does not vary linearly with the length of the time series i.e. a certain amount of smoothing per unit interval in time. This is a deliberate choice because should one be interested in a subset (in time) of data, more detail will be provided for the subset compared with the full data set. This allows users to investigate specific periods in more detail. Full flexibility is given through the smoothing parameter k.

See Also

polarPlot, polarFreq, pollutionRose and percentileRose

Examples

Run this code
# load example data from package
data(mydata)

# diurnal plot for PM10 at Marylebone Rd
polarAnnulus(mydata, pollutant = "pm10", main = "diurnal variation in pm10 at Marylebone Road")

# seasonal plot for PM10 at Marylebone Rd
polarAnnulus(mydata, poll="pm10", period = "season")

# trend in coarse particles (PMc = PM10 - PM2.5), calculate PMc first

mydata$pmc <- mydata$pm10 - mydata$pm25
polarAnnulus(mydata, poll="pmc", period = "trend",
main = "trend in pmc at Marylebone Road")

Run the code above in your browser using DataLab