fish {fishualize}

fish Colour Map.

Description

This function creates a vector of n equally spaced colors along the 'fish colour map' of your selection

Usage

fish(
  n,
  alpha = 1,
  begin = 0,
  end = 1,
  direction = 1,
  option = "Centropyge_loricula"
)

fish_pal(
  alpha = 1,
  begin = 0,
  end = 1,
  direction = 1,
  option = "Centropyge_loricula"
)

Arguments

n

The number of colors (\ge 1) to be in the palette.

alpha

The alpha transparency, a number in [0,1], see argument alpha in hsv.

begin

The (corrected) hue in [0,1] at which the fish colormap begins.

end

The (corrected) hue in [0,1] at which the fish colormap ends.

direction

Sets the order of colors in the scale. If 1, the default, colors are ordered from darkest to lightest. If -1, the order of colors is reversed.

option

A character string indicating the fish species to use.

Value

fish returns a character vector, cv, of color hex codes. This can be used either to create a user-defined color palette for subsequent graphics by palette(cv), a col = specification in graphics functions or in par.

Semi-transparent colors (0 < alpha < 1) are supported only on some devices: see rgb.

Examples

library(ggplot2)
library(fishualize)

dat <- data.frame(x = rnorm(1e4), y = rnorm(1e4))
ggplot(dat, aes(x = x, y = y)) +
  stat_density_2d(geom = "raster",
  aes(fill = after_stat(density)), contour = FALSE) +
  scale_fill_gradientn(colors = fish(128, option = 'Ostracion_cubicus'))

pal <- fish(256, option = "Thalassoma_hardwicke", direction = -1)
image(volcano, col = pal)