utils_check_args_momentum: Check Input Arguments of 'momentum()'

In BlasBenito/distantia: Advanced Toolset for Efficient Time Series Dissimilarity Analysis

Check Input Arguments of momentum()

Description

Check Input Arguments of momentum()

Usage

utils_check_args_momentum(
  tsl = NULL,
  distance = NULL,
  diagonal = NULL,
  bandwidth = NULL,
  lock_step = NULL,
  robust = 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.
robust	(required, logical). If TRUE (default), importance scores are computed using the least cost path of the complete time series as reference. Setting it to FALSE allows to replicate importance scores of the previous versions of this package. This option is irrelevant when lock_step = TRUE. Default: TRUE

Value

list

See Also

Other internal: utils_boxplot_common(), utils_check_args_distantia(), utils_check_args_matrix(), 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()

BlasBenito/distantia documentation built on Feb. 21, 2025, 2:48 a.m.