wmf_methods: Basic methods for the 'wmf' class

Description Usage Arguments Value Author(s) See Also Examples

Description

Set, get, summary, and print methods for the wmf class.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
## S3 method for class 'wmf'
summary(object, ...)

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

## S3 method for class 'wmf'
set_times(obj, newval)

## S3 method for class 'wmf'
set_timescales(obj, newval)

## S3 method for class 'wmf'
set_values(obj, newval)

## S3 method for class 'wmf'
set_dat(obj, newval)

## S3 method for class 'wmf'
set_wtopt(obj, newval)

## S3 method for class 'wmf'
get_times(obj)

## S3 method for class 'wmf'
get_timescales(obj)

## S3 method for class 'wmf'
get_values(obj)

## S3 method for class 'wmf'
get_dat(obj)

## S3 method for class 'wmf'
get_wtopt(obj)

Arguments

object, x, obj

An object of class wmf

...

Not currently used. Included for argument consistency with existing generics.

newval

A new value, for the set_* methods

Value

summary.wmf produces a summary of a wmf object. A print.wmf method is also available. For wmf objects, set_* and get_* methods are available for all slots, i.e., * equal to times, timescales, wtopt, values, and dat. The set_* methods just throw an error, to prevent breaking the consistency between the slots of a wmf object.

Author(s)

Daniel Reuman, reuman@ku.edu

See Also

wmf

Examples

1
2
3
4
5
6
7
8
times<-1:30 #generate time steps
#generate fake count data for 20 locations
dat<-matrix(rpois(20*length(times),20),nrow=20,ncol=length(times)) 
dat<-cleandat(dat=dat,times=times,clev=2)$cdat #detrend and demean
h<-wmf(dat,times)
get_times(h)
summary(h)
print(h)

wsyn documentation built on Jan. 15, 2021, 3:37 p.m.