matchtime: Match the dates of a time-dependent variable with a...

Description Usage Arguments Value Examples

Description

The function takes a variable x (e.g. a vector or a RasterArray object), and reorders it to best match the dates provided in a vector y.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
matchtime(x, y, ...)

## S4 method for signature 'numeric'
matchtime(x, y, index = FALSE, ...)

## S4 method for signature 'character'
matchtime(x, y, index = FALSE, ...)

## S4 method for signature 'RasterArray'
matchtime(x, y, index = FALSE, time = 1, ...)

Arguments

x

Object to be reordered to match y.

y

(numeric) The vector of dates (numeric values) to order to.

...

Additional arguments passed to class-specific methods.

index

(logical) If this argument is TRUE, only the indices will be returned that refer to the new order, rather than the reordered x variable.

time

numeric. Single value referring to that dimension of x where the time-coding names are (time=1 is the default for RasterArrays in chronosphere).

Value

An object of the class as x or a numeric vector.

Examples

1
2
3
4
5
6
# original vector
orig <- 1:10
# target values
targ <- c(5.1,4.2, 3.4, 2.7, 2.3)
# how do the two series match the best?
matchtime(orig, targ)

chronosphere documentation built on April 19, 2021, 1:07 a.m.