R: Spread Out a Vector of Numbers To a Minimum Interval

SpreadOut {DescTools}

R Documentation

Spread Out a Vector of Numbers To a Minimum Interval

Description

Spread out a vector of numbers so that there is a minimum interval between any two numbers when in ascending or descending order.

Usage

SpreadOut(x, mindist = NULL, cex = 1.0)

Arguments

`x`	a numeric vector which may contain `NA`s.
`mindist`	the minimum interval between any two values when in ascending or descending order. If this is left to `NULL` (default) the function will check if a plot is open and then use 90% of `strheight`.
`cex`	numeric character expansion factor; multiplied by `par("cex")` yields the final character size; the default `NULL` is equivalent to `1`.

Details

SpreadOut starts at or near the middle of the vector and increases the intervals between the ordered values. NAs are preserved. SpreadOut first tries to spread groups of values with intervals less than mindist out neatly away from the mean of the group. If this doesn't entirely succeed, a second pass that forces values away from the middle is performed.

SpreadOut is currently used to avoid overplotting of axis tick labels where they may be close together.

Value

On success, the spread out values. If there are less than two valid values, the original vector is returned.

Note

This function is borrowed from the package plotrix (SpreadOut) and has been integrated here with some minor changes.

Author(s)

Jim Lemon <jim@bitwrit.com.au>
some extensions Andri Signorell <andri@signorell>

Examples

SpreadOut(c(1, 3, 3, 3, 3, 5), 0.2)
SpreadOut(c(1, 2.5, 2.5, 3.5, 3.5, 5), 0.2)
SpreadOut(c(5, 2.5, 2.5, NA, 3.5, 1, 3.5, NA), 0.2)

# this will almost always invoke the brute force second pass
SpreadOut(rnorm(10), 0.5)

[Package DescTools version 0.99.24 Index]