utils_check_args_distantia: Check Input Arguments of 'distantia()'

In distantia: Advanced Toolset for Efficient Time Series Dissimilarity Analysis

Check Input Arguments of distantia()

Description

Check Input Arguments of distantia()

Usage

utils_check_args_distantia(
  tsl = NULL,
  distance = NULL,
  diagonal = NULL,
  bandwidth = NULL,
  lock_step = NULL,
  repetitions = NULL,
  permutation = NULL,
  block_size = NULL,
  seed = NULL
)

Arguments

tsl	(required, time series list) list of zoo time series. 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".
diagonal	(optional, logical vector). If TRUE, diagonals are included in the dynamic time warping computation. Default: TRUE
bandwidth	(optional, numeric) Proportion of space at each side of the cost matrix diagonal (aka Sakoe-Chiba band) defining a valid region for dynamic time warping, used to control the flexibility of the warping path. This method prevents degenerate alignments due to differences in magnitude between time series when the data is not properly scaled. If 1 (default), DTW is unconstrained. If 0, DTW is fully constrained and the warping path follows the matrix diagonal. Recommended values may vary depending on the nature of the data. Ignored if lock_step = TRUE. Default: 1.
lock_step	(optional, logical vector) If TRUE, time series captured at the same times are compared sample wise (with no dynamic time warping). Requires time series in argument tsl to be fully aligned, or it will return an error. Default: FALSE.
repetitions	(optional, integer vector) number of permutations to compute the p-value. If 0, p-values are not computed. Otherwise, the minimum is 2. The resolution of the p-values and the overall computation time depends on the number of permutations. Default: 0
permutation	(optional, character vector) permutation method, only relevant when repetitions is higher than zero. Valid values are: "restricted_by_row", "restricted", "free_by_row", and "free". Default: "restricted_by_row".
block_size	(optional, integer) Size of the row blocks for the restricted permutation test. Only relevant when permutation methods are "restricted" or "restricted_by_row" and repetitions is higher than zero. A block of size n indicates that a row can only be permuted within a block of n adjacent rows. If NULL, defaults to the rounded one tenth of the shortest time series in tsl. Default: NULL.
seed	(optional, integer) initial random seed to use for replicability when computing p-values. Default: 1

Value

list

See Also

Other internal: utils_boxplot_common(), utils_check_args_matrix(), utils_check_args_momentum(), utils_check_args_path(), utils_check_args_tsl(), utils_check_args_zoo(), utils_check_distance_args(), utils_check_list_class(), utils_clean_names(), utils_digits(), utils_distantia_df_split(), utils_prepare_df(), utils_prepare_matrix(), utils_prepare_matrix_list(), utils_prepare_time(), utils_prepare_vector_list(), utils_prepare_zoo_list(), utils_tsl_pairs()

distantia documentation built on April 4, 2025, 5:42 a.m.