distantia (version 2.0.2)

psi_distance_lock_step: Lock-Step Distance

Description

Demonstration function to compute the lock-step distance between two univariate or multivariate time series.

This function does not accept NA data in the matrices x and y.

Usage

psi_distance_lock_step(x = NULL, y = NULL, distance = "euclidean")

Value

numeric

Arguments

x

(required, zoo object or numeric matrix) a time series with no NAs. Default: NULL

y

(zoo object or numeric matrix) a time series with the same columns as x and no NAs. Default: NULL

distance

(optional, character vector) name or abbreviation of the distance method. Valid values are in the columns "names" and "abbreviation" of the dataset distances. Default: "euclidean".

See Also

Other psi_demo: psi_auto_distance(), psi_auto_sum(), psi_cost_matrix(), psi_cost_path(), psi_cost_path_sum(), psi_distance_matrix(), psi_equation()

Examples

#distance metric
d <- "euclidean"

#simulate two time series
#of the same length
x <- zoo_simulate(
  name = "x",
  rows = 100,
  seasons = 2,
  seed = 1
)

y <- zoo_simulate(
  name = "y",
  rows = 100,
  seasons = 2,
  seed = 2
)

if(interactive()){
  zoo_plot(x = x)
  zoo_plot(x = y)
}

#sum of distances
#between pairs of samples
psi_distance_lock_step(
  x = x,
  y = y,
  distance = d
)