xts (version 0.0-13)

endpoints: Locate Endpoints by Time

Description

Extract index values of a given xts object corresponding to the last observations given a period specified by on

Usage

endpoints(x, on="months", k=1)

Arguments

x

an xts object

on

the periods endpoints to find as a character string

k

along every k-th element - see notes

Value

• A numeric vector of endpoints beginning with 0 and ending with the a value equal to the length of the x argument.

Details

endpoints returns a numeric vector corresponding to the last observation in each period specified by on, with a zero added to the beginning of the vector, and the index of the last observation in x at the end.

Valid values for the argument on include: secs (seconds), seconds, mins (minutes), minutes, hours, days, weeks, months, quarters, and years.

The k argument is only valid for values of on equaling minutes and seconds. All other values will ignore the k argument.

Examples

data(sample_matrix)

endpoints(sample_matrix)
endpoints(sample_matrix, 'weeks')