Squish values into range

Source: R/out_of_bounds.R

This function follows the squish function, but allows extentions that work with objects other than numeric vectors.

squishThis(x, range = NULL, only.finite = TRUE, aes = "z")

# S4 method for WoodenHorse,ANY
squishThis(x, range = c(0, 1), only.finite = TRUE, aes = "z")

# S4 method for numeric,numeric_OR_missing
squishThis(x, range = c(0, 1), only.finite = TRUE, aes = "z")

# S4 method for Rle,numeric_OR_missing
squishThis(x, range = c(0, 1), only.finite = TRUE, aes = "z")

# S4 method for IntegerRanges,numeric_OR_missing
squishThis(x, range = c(0, 1), only.finite = TRUE, aes = "z")

# S4 method for ANYGenomic,GRanges
squishThis(x, range = GRanges(NA_character_, IRanges(0, 1)))

Arguments

x

A vector of values to manipulate.
range

A range representing object.
only.finite

If TRUE (the default), will only modify finite values.
aes

An aesthetic for which to evaluate the function.

Value

The x argument, but with out-of-bounds values squished to the range.

Examples

# For regular numeric vectors
squishThis(c(-1, 0.5, 1, 2, NA))
#> [1] 0.0 0.5 1.0 1.0  NA

# For Rle-class
squishThis(Rle(1:4, 4:1), c(2,3))
#> numeric-Rle of length 10 with 2 runs
#>   Lengths: 7 3
#>   Values : 2 3