Common Boxplot Component of distantia_boxplot() and momentum_boxplot()

Common Boxplot Component of distantia_boxplot() and momentum_boxplot()

Usage

utils_boxplot_common(
  variable = NULL,
  value = NULL,
  fill_color = NULL,
  f = median,
  main = NULL,
  xlab = NULL,
  ylab = NULL,
  text_cex = 1
)

Arguments

variable

(required, character vector) vector with variable or time series names. Default: NULL

value

(required, numeric vector) vector of numeric values to compute the boxplot for. Must have the same length as variable. Default: NULL

fill_color

(optional, character vector) boxplot fill color. Default: NULL

f

(optional, function) function used to aggregate the input data frame and arrange the boxes. One of mean or median. Default: median.

main

(optional, string) boxplot title. Default: NULL

xlab

(optional, string) x axis label. Default: NULL

ylab

(optional, string) y axis label. Default: NULL

text_cex

(optional, numeric) Multiplier of the text size. Default: 1

Value

boxplot

See also

Other internal: 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_distantia_df_to_matrix(), 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_boxplot_common(
  variable = rep(x = c("a", "b"), times = 50),
  value = stats::runif(100)
)