start.tis: Starting and ending time indexes

Description Usage Arguments Value Note See Also Examples

View source: R/tis.R

Description

Return the start or end time index for a tis object.

Usage

1
2
3
4
5
## S3 method for class 'tis'
start(x, ...)
## S3 method for class 'tis'
end(x, ...)
start(x) <- value

Arguments

x

a tis object

value

desired start attribute

...

ignored

Value

start.tis returns the start attribute of x, while end.tis returns start(x) + nobs(x) - 1. start(x) <- value returns the series x shifted such that it's starting time is value.

Note

start and end are generic functions with default methods that assume x has (or can be given) a tsp attribute. The default methods return a two vector as c(year, period), while the methods described here return infinitely more useful ti objects.

See Also

start,end

Examples

1
2
3
x <- tis(numeric(8), start = c(2001, 1), freq = 4)
start(x)           ## --> ti object representing 2001Q1
start(as.ts(x))    ## --> c(2001, 1)

tis documentation built on Sept. 29, 2021, 1:06 a.m.