n_dist2ref {COINr}

Normalise as distance to reference value

Description

A measure of the distance to a specific value found in x, specified by iref. The formula is:

Usage

n_dist2ref(x, iref, cap_max = FALSE)

Arguments

x

A numeric vector

iref

An integer which indexes x to specify the reference value. The reference value will be x[iref].

cap_max

If TRUE, any value of x that exceeds x[iref] will be assigned a score of 1, otherwise will have a score greater than 1.

Details

1 - (x_{ref} - x)/(x_{ref} - x_{min})

Values exceeding x_ref can be optionally capped at 1 if cap_max = TRUE.

Value

Numeric vector

Examples

x <- runif(20)
n_dist2ref(x, 5)