n_zscore: Z-score a vector

In COINr: Composite Indicator Construction and Analysis

Z-score a vector

Description

Standardises a vector x by scaling it to have a mean and standard deviation specified by m_sd.

Usage

n_zscore(x, m_sd = c(0, 1))

Arguments

x	A numeric vector
m_sd	A vector c(m, sd), where m is desired mean and sd is the target standard deviation.

Details

This function also supports parameter specification in iMeta for the Normalise.coin() method. To do this, add columns zscore_mean, and zscore_sd to the iMeta table, which specify the mean and standard deviation to scale each indicator to, respectively. Then set f_n_para = "use_iMeta" within the global_specs list. See also examples in the normalisation vignette.

Value

Numeric vector

Examples

x <- runif(20)
n_zscore(x)

COINr documentation built on May 29, 2024, 1:18 a.m.