make.index.unique: Force Time Values To Be Unique

In joshuaulrich/xts: eXtensible Time Series

Force Time Values To Be Unique

Description

A generic function to force sorted time vectors to be unique. Useful for high-frequency time-series where original time-stamps may have identical values. For the case of xts objects, the default eps is set to ten microseconds. In practice this advances each subsequent identical time by eps over the previous (possibly also advanced) value.

Usage

is.index.unique(x)

is.time.unique(x)

make.index.unique(x, eps = 1e-06, drop = FALSE, fromLast = FALSE, ...)

make.time.unique(x, eps = 1e-06, drop = FALSE, fromLast = FALSE, ...)

Arguments

x	An xts object, or POSIXct vector.
eps	A value to add to force uniqueness.
drop	Should duplicates be dropped instead of adjusted by eps?
fromLast	When drop = TRUE, fromLast controls which duplicated times are dropped. When fromLast = FALSE, the earliest observation with an identical timestamp is kept and subsequent observations are dropped.
...	Unused.

Details

The returned time-series object will have new time-stamps so that isOrdered(.index(x)) evaluates to TRUE.

Value

A modified version of x with unique timestamps.

Note

Incoming values must be pre-sorted, and no check is done to make sure that this is the case. ‘integer’ index value will be coerced to ‘double’ when drop = FALSE.

Author(s)

Jeffrey A. Ryan

See Also

align.time()

Examples

ds <- options(digits.secs=6) # so we can see the change

x <- xts(1:10, as.POSIXct("2011-01-21") + c(1,1,1,2:8)/1e3)
x
make.index.unique(x)

options(ds)

joshuaulrich/xts documentation built on Nov. 17, 2024, 6:37 a.m.