sym: sym: Get A Numeric Range That Is Symmetric Around Zero

In mwrowe/microRutils: Mike Rowe's Miscellaneous R Utility Functions

Description

sym returns a symmetric numeric interval, centered about zero.

Usage

sym(lims = 1, qtile = 1)

Arguments

lims	A numeric value or vector. If its length is greater than one, the quantile specified by the qtile argument will be calculated for the absolute values of lims.
qtile	A numeric value in the range 0-1 (inclusive). If lims contains multiple values, this quantile of the distributions of abs(lims) will be used to define the interval. The default value of 1 will return max(abs(lims)).

Details

This function is useful for setting symmetric limits on graphs (among other things.)

Value

Returns a symmetric interval about zero, from -lims to lims, or if lims contains more than one value, a symmetric interval about zero that contains the fraction of the data specified by qtile.

Author(s)

M.W.Rowe, [e-mail]

mwrowe/microRutils documentation built on June 12, 2021, 2:41 p.m.