seas.check: Check the suitability of a data.frame, or seas.sum for seas

Description

Check the suitability of a data.frame or seas.sum object for seas.

Usage

seas.df.check(x, orig, var)
seas.sum.check(x, orig, var, norm, year.filter, ann.only)

Arguments

a data frame with temporal observations

orig

the original name of the data frame, for error messages

var

one or more variables in x, which are tested; ignored if NULL or missing

norm

something to normalize var; it can either be the name of an array in x, a matrix (bin vs years), or a 3-dim array (used to normalize multiple var); this is tested to see if norm exists, and that the dimension are consistent with x

year.filter

a subset of x$years, which filters all the related arrays in the returned value

ann.only

x$seas arrays are ignored

Value

seas.df.check returns a few helpful items from x in a list using invisible:

id:station ID from one of attr(x,"id") or x$id[1]
name:name of seasonal data, such as a place
year.range:integers of start, and ending years
calendar:an attribute from x$date; otherwise this will be NULL for a normal proleptic Gregorian calendar
main:main title, from .seastitle
units:units for var[1]
long.name:long name for var[1]
ylab:y-axis label for var[1]

seas.sum.check returns x with modifications, depending on norm and year.filter.

Details

This utility function simply checks the suitability of a data.frame or seas.sum objects for use with seas.

If x is data.frame (using seas.df.check that is really required, is a ‘date’ column, named x$date with a class of either link{POSIXct} or link{Date}, and one or more variables in the var columns of x.

There must be at least one finite observation in each of var, if supplied.

These function is used within other functions, and is not intended to be called directly.

Examples

Run this code

# NOT RUN {
data(mscdata)
dat <- mksub(mscdata, id=1108447)
str(seas.df.check(dat))

dat.ss <- seas.sum(dat)
str(seas.sum.check(dat.ss, norm="days"))
# }