hidden: Return title and properties for seasonal graphs

In seas: Seasonal Analysis and Graphics, Especially for Climatology

Return title and properties for seasonal graphs

Description

Return title, x- and y-axis labels for seasonal graphs. Also, draw the month grid.

Usage

.seasxlab(width, start.day)
.seasylab(var, long.name = NULL, units = NULL)
.seastitle(main = NULL, id = NULL, name = NULL,
           orig = NULL, fun = NULL, range = NA)
.seasmonthgrid(width, days, start = 1, rep = 0, start.day = 1, month.label)

Arguments

orig	original object name, which is used if no other name can be found from id or name
var	original variable name in names(orig)
width	size of bin; see mkseas
start.day	the starting day of annum for the first bin; as either a Date or integer of day of the year
main	main title of plot; overrides any other title, but appends year range if show.range=TRUE
long.name	a long name for var, used for labelling y-axis
units	units of var, used for labelling y-axis
id	station ID, which is used to fetch a station name using getstnname
name	a name, which is used for labels
fun	function, if applicable
range	year range; c(start.year, end.year)
days	also known as bin.lengths, which represents the maximum number of days expected in each bin for a complete annum
start	the starting bin number
rep	the number of repeated bins
month.label	logical; put month name labels on grid

Details

These functions are intended for producing the graphics, and do not need to be used directly.

The month grid is drawn by .seasmonthgrid, and can be fine-tuned by setting some options in the R environment, found in seas.month.grid. This list, for instance, has len to adjust the length of each month label, and col for the colour of the lines. See SeasOpts for all available options, and instructions on how to change them.

The main and variable/unit label formating can also be customized by setting other options, documented in SeasOpts.

Value

.seasxlab, .seasylab and .seastitle return a character label intended for plots.

Author(s)

Mike Toews

See Also

getstnname, SeasOpts

Examples

setSeasOpts()

.seasxlab(11, 1)
.seasxlab("mon", 1)

# Not starting on January 1st
.seasxlab(11, 120)

# Labelled according to month (and possibly day)
getOption("seas.label")$month
.seasxlab("mon", as.Date("2000-08-01"))
getOption("seas.label")$monthday
.seasxlab(365/20, as.Date("2000-08-15"))

seas documentation built on May 2, 2022, 5:08 p.m.