utils_check_distance_args: Check Distance Argument

View source: R/utils_check_args.R

utils_check_distance_argsR Documentation

Check Distance Argument

Description

Check Distance Argument

Usage

utils_check_distance_args(distance = NULL)

Arguments

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

character vector

See Also

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

Examples


utils_check_distance_args(
  distance = c(
    "euclidean",
    "euc"
   )
  )

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