val2ggcol {sccore}

Helper function to return a ggplot color gradient for a numeric vector ggplot(aes(color=x, ...), ...) + val2ggcol(x)

Description

Helper function to return a ggplot color gradient for a numeric vector ggplot(aes(color=x, ...), ...) + val2ggcol(x)

Usage

val2ggcol(
  values,
  gradient.range.quantile = 1,
  color.range = "symmetric",
  palette = NULL,
  midpoint = NULL,
  oob = scales::squish,
  return.fill = FALSE,
  ...
)

Arguments

values

values by which the color gradient is determined

gradient.range.quantile

numeric Trimming quantile (default=1). Either a single number or two numbers - for lower and upper quantile.

color.range

either a vector of two values explicitly specifying the values corresponding to the start/end of the gradient, or string "symmetric" or "all" (default="symmetric"). "symmetric": range will fit data, but will be symmetrized around zeros, "all": gradient will match the span of the range of the data (after gradient.range.quantile)

palette

an optional palette (default=NULL). The default becomes blue-gray90-red; if the values do not straddle 0, then truncated gradients (blue-gray90 or gray90-red) will be used

midpoint

optional midpoint (default=NULL). Set for the center of the resulting range by default

oob

function to determine what to do with the values outside of the range (default =scales::squish). Refer to 'oob' parameter in ggplot

return.fill

boolean Whether to return fill gradients instead of color (default=FALSE)

...

additional arguments are passed to ggplot2::scale_color_gradient* functions, i.e. scale_color_gradient(), scale_color_gradient2(), scale_color_gradientn()

Value

ggplot2::scale_colour_gradient object