Auto Sum

Demonstration function to computes the sum of distances between consecutive samples in two time series.

Usage

psi_auto_sum(x = NULL, y = NULL, path = NULL, distance = "euclidean")

Arguments

x

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

y

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

path

(required, data frame) least cost path produced by psi_cost_path(). Only required when psi_cost_path_ignore_blocks() has been applied to path. 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".

Value

numeric vector

See also

Other psi_demo: distance(), distances, psi_auto_distance(), psi_cost_matrix(), psi_cost_path(), psi_cost_path_ignore_blocks(), psi_cost_path_sum(), psi_distance_lock_step(), psi_distance_matrix(), psi_equation()

Examples

#distance metric
d <- "euclidean"

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

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

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

#auto sum of distances
psi_auto_sum(
  x = x,
  y = y,
  distance = d
)
#> [1] 14.79953

#same as:
x_sum <- psi_auto_distance(
  x = x,
  distance = d
)

y_sum <- psi_auto_distance(
  x = y,
  distance = d
)

x_sum + y_sum
#> [1] 14.79953