r1sd: Scale a vector by one standard deviation

View source: R/r1sd.R

r1sdR Documentation

Scale a vector by one standard deviation

Description

r1sd allows you to rescale a numeric vector such that the ensuing output has a mean of 0 and a standard deviation of 1.

Usage

r1sd(x, na = TRUE)

Arguments

x

a numeric vector

na

what to do with NAs in the vector. Defaults to TRUE (i.e. passes over the missing observations)

Details

This is a convenience function since the default rescale() function has some additional weirdness that is not welcome for my use cases. By default, na.rm is set to TRUE.

Value

The function returns a numeric vector rescaled with a mean of 0 and a standard deviation of 1.

Examples


x <- rnorm(100)
r1sd(x)

stevemisc documentation built on April 12, 2022, 5:06 p.m.