clamp: Limit values to a given range

In jcalendo/coriell: Convenience Functions for Bioinformatics

Limit values to a given range

Description

This function is useful for input validation. If the value of x is in the given range then the function returns x. If the value is outside of the range then the function returns either the max or the min value of the range.

Usage

clamp(x, min, max)

Arguments

x	numeric. Value to validate
min	numeric. Minimum value of range.
max	numeric. Maximum value of range.

Value

The clamped value.

Examples

clamp(c(-1, 121, 10, 15), min = 0, max = 100)

jcalendo/coriell documentation built on March 5, 2025, 5:42 a.m.