clip: Clip Values

View source: R/convenience.R

clipR Documentation

Clip Values

Description

Clip (i.e., limit) the values in a vector, matrix, or array.

Usage

clip(x, .min, .max, ...)

## Default S3 method:
clip(x, .min, .max, ...)

Arguments

x

A vector, matrix, or multi-way array.

.min

Minimum value.

.max

Maximum value.

...

Additional optional arguments.

Value

Returns x with values outside the interval [.min, .max] clipped to the interval edges. That is, values in x smaller than .min become .min, and values larger than .max become .max.

Examples

clip(1:10, 3, 8) # [1] 3 3 3 4 5 6 7 8 8 8
clip(randn(5, 5), .min = -1, .max = 1)

ramify documentation built on June 24, 2025, 9:07 a.m.