2.1.generic.pems.handlers: Generic handling of pems objects

In pems: tools for the analysis and visualisation of pems data

Description

pems objects can be manipulated using generic functions like print, plot and summary in a similar fashion to objects of other R classes.

Usage

## S3 method for class 'pems'
names(x, ...)

## S3 method for class 'pems'
print(x, verbose = FALSE, ...)

## S3 method for class 'pems'
plot(x, id = NULL, ignore = "time.stamp", n = 3, ...)

## S3 method for class 'pems'
summary(object, ...)

Arguments

x, object	(An Object of pems class). For direct use with print, plot, summary, etc. NOTE: Object naming (i.e., x or object) is determined in parent or base function in R, so naming can vary by method.
...	Addition options, typically passed to associated default method(s).
verbose	(Logical, TRUE/FALSE). Should the longer form of the output be returned? By default, functions with short and long output versions return the short form.
id, ignore, n	(local plot parameters). id identifies which data series to plot; ignore identifies which data series to ignore when leaving the choice of id to the function; and, n gives the maximum number of data series to plot when leaving the choice of id to the function.

Value

Generic functions provide appropriate (conventional) handling of objects of 'pems' class:

print(pems.object) provides a (to console) description of that pems object.

plot(pems.object) generates a standard R plot using selected data series in that pems object.

names(pems.object) returns a vector of the names of data series held in a pems object.

summary(pems.object) generates a summary report for data series held in a pems object.

Author(s)

Karl Ropkins

Examples

## Not run: 

#make object
print(pems.object)
names(pems.object)


## End(Not run) 

pems documentation built on May 2, 2019, 5:20 p.m.