healthyR.ai (version 0.1.0)

hai_scale_zero_one_augment: Augment Function Scale Zero One

Description

Takes a numeric vector and will return a vector that has been scaled from [0,1]

Usage

hai_scale_zero_one_augment(.data, .value, .names = "auto")

Value

An augmented tibble

Arguments

.data

The data being passed that will be augmented by the function.

.value

This is passed rlang::enquo() to capture the vectors you want to augment.

.names

This is set to 'auto' by default but can be a user supplied character string.

Author

Steven P. Sanderson II, MPH

Details

Takes a numeric vector and will return a vector that has been scaled from [0,1] The input vector must be numeric. The computation is fairly straightforward. This may be helpful when trying to compare the distributions of data where a distribution like beta from the fitdistrplus package which requires data to be between 0 and 1

$$y[h] = (x - min(x))/(max(x) - min(x))$$

This function is intended to be used on its own in order to add columns to a tibble.

See Also

Other Augment Function: hai_fourier_augment(), hai_fourier_discrete_augment(), hai_hyperbolic_augment(), hai_polynomial_augment(), hai_scale_zscore_augment(), hai_winsorized_move_augment(), hai_winsorized_truncate_augment()

Other Scale: hai_scale_zero_one_vec(), hai_scale_zscore_augment(), hai_scale_zscore_vec(), step_hai_scale_zscore()

Examples

df <- data.frame(x = rnorm(100, 2, 1))
hai_scale_zero_one_augment(df, x)