Trim a Numeric Vector

Sets the values in a numeric vector that are beyond the specified quantiles to NA, based on the cut parameter. Values below the cut quantile and above the 1 - cut quantile become NA; the length of x is unchanged, which is the useful behaviour inside dplyr::mutate().

Usage

trim(x, cut)

Arguments

x

A numeric vector to be trimmed.

cut

The proportion of data to be trimmed from both ends of the distribution. For example, a cut of 0.05 will remove the lowest and highest 5% of the data. Must be in [0, 0.5].

Value

A numeric vector the same length as x, with the values outside the cut and 1 - cut quantiles set to NA.

See also

Other utility functions: create_summary_statistics(), get_available_huggingface_files(), list_supported_datasets(), list_supported_datasets_ff(), list_supported_datasets_ff_legacy(), list_supported_datasets_macro_predictors(), list_supported_datasets_other(), list_supported_datasets_pseudo(), list_supported_datasets_wrds(), list_supported_indexes(), list_supported_jkp_factors(), list_tidy_finance_chapters(), open_tidy_finance_website(), validate_dates(), winsorize()

Examples

set.seed(123)
data <- rnorm(100)
trimmed_data <- trim(x = data, cut = 0.05)