scale_protti: Scaling a vector

View source: R/scale_protti.R

scale_prottiR Documentation

Scaling a vector

Description

scale_protti is used to scale a numeric vector either between 0 and 1 or around a centered value using the standard deviation. If a vector containing only one value or repeatedly the same value is provided, 1 is returned as the scaled value for method = "01" and 0 is returned for metod = "center".

Usage

scale_protti(x, method, default_to_high = TRUE)

Arguments

x

a numeric vector

method

a character value that specifies the method to be used for scaling. "01" scales the vector between 0 and 1. "center" scales the vector equal to base::scale around a center. This is done by subtracting the mean from every value and then deviding them by the standard deviation.

default_to_high

if there is only one number in the vector the "01" method will default to scale this to 1. If this argument is set to FALSE it will be scaled to 0 instead.

Value

A scaled numeric vector.

Examples

scale_protti(c(1, 2, 1, 4, 6, 8), method = "01")

protti documentation built on Jan. 14, 2026, 9:08 a.m.