tsvreq_classic_methods: Basic methods for the 'tsvreq_classic' class

In reumandc/tsvr: Timescale-Specific Variance Ratio for Use in Community Ecology

Description

Set, get, summary, print and plot methods for the tsvreq_classic class.

Usage

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

## S3 method for class 'tsvreq_classic'
print(x, ...)

## S3 method for class 'tsvreq_classic'
plot(x, filename = NA, ...)

## S3 method for class 'tsvreq_classic'
set_ts(obj, newval)

## S3 method for class 'tsvreq_classic'
set_com(obj, newval)

## S3 method for class 'tsvreq_classic'
set_comnull(obj, newval)

## S3 method for class 'tsvreq_classic'
set_tsvr(obj, newval)

## S3 method for class 'tsvreq_classic'
set_wts(obj, newval)

## S3 method for class 'tsvreq_classic'
get_ts(obj)

## S3 method for class 'tsvreq_classic'
get_com(obj)

## S3 method for class 'tsvreq_classic'
get_comnull(obj)

## S3 method for class 'tsvreq_classic'
get_tsvr(obj)

## S3 method for class 'tsvreq_classic'
get_wts(obj)

Arguments

object, x, obj	An object of class tsvreq_classic
...	Passed to plot. Not currently used for other methods, included there only for argument consistency with existing generics.
filename	A filename, no extension, could have a path. Used for saving a plot as a pdf. The default value NA causes the default plotting device to be used.
newval	A new value, for the set_* methods

Value

summary.tsvreq_classic produces a summary of a tsvreq_classic object. Methods print.tsvreq_classic and plot.tsvreq_classic are also available. For tsvreq_classic objects, set_* and get_* methods are available for all slots (see the documentation for tsvreq_classic for a list). The set_* methods just throw an error, to prevent breaking the consistency between the slots of a tsvreq_classic object.

Author(s)

Daniel Reuman, [e-mail]

References

Zhao et al, (In prep) Decomposition of the variance ratio illuminates timescale-specific population and community variability.

See Also

tsvreq_classic

Examples

X<-matrix(runif(10*100),10,100)
res<-tsvreq_classic(X)
get_ts(res)
print(res)
summary(res)
 

reumandc/tsvr documentation built on Jan. 17, 2021, 10:32 p.m.