squishThis: Squish values into range

In teunbrand/ggnomics: ggnomics

Description

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

Usage

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

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

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

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

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

## S4 method for signature '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))

# For Rle-class
squishThis(Rle(1:4, 4:1), c(2,3))

teunbrand/ggnomics documentation built on Aug. 2, 2020, 7:34 p.m.