Package 'poispalette'

lines

Description

lines

Usage

lines

Format

An example data set for plotting

Examples

lines

---

points

Description

points

Usage

points

Format

An example data set for plotting

Examples

points

---

poisson colours

Description

poisson colours

Usage

pois_cols(colours = NULL)

Arguments

colours

Character names of Poisson colours

Value

A named character vector of hex colours

Examples

pois_cols()
pois_cols(c("red", "yellow"))

---

poisson palettes

Description

poisson palettes

Usage

pois_pal(palette = NULL)

Arguments

palette

Character names of Poisson palettes. One of 'discrete', 'hot', 'cool'.

Value

A named character vector of hex colours

Examples

pois_pal()
pois_pal("cool")

---

Return function to subset a user provided colour palette

Description

Return function to subset a user provided colour palette

Usage

pois_pal_custom(palette, order = NULL, reverse = FALSE)

Arguments

palette	Character vector of hex colours.
order	A numeric or character vector indicating the order of colours in the palette. Can be a subset.
reverse	Boolean indicating whether the palette should be reversed

Value

A function that takes the number of colours required and returns a character vector of that many hex colours from the palette.

Examples

pois_pal_custom(c("#1E6091", "#D9ED92", "#99D98C"))(3)

---

Return function to subset poisson colour palette

Description

Return function to subset poisson colour palette

Usage

pois_pal_disc(palette = "discrete", order = NULL, reverse = FALSE)

Arguments

palette	Character name of palette. See pois_pal() for palette options.
order	A numeric or character vector indicating the order of colours in the palette. Can be a subset.
reverse	Boolean indicating whether the palette should be reversed

Value

A function that takes the number of colours required and returns a character vector of that many hex colours from the palette.

Examples

pois_pal_disc("discrete")(3)

---

Return interpolated color gradient for a continuous poisson colour palette

Description

Return interpolated color gradient for a continuous poisson colour palette

Usage

pois_pal_grad(
  palette = "cool",
  reverse = FALSE,
  n_steps = 256,
  n_col = getOption("poispalette.n_col", NULL)
)

Arguments

palette	Character name of palette in pois_palettes, See pois_pal() for palette options.
reverse	Boolean indicating whether the palette should be reversed
n_steps	Number of steps in gradient
n_col	Number of colours to subset from the palette (optional)

Value

A character vector of n_steps interpolated hex colours.

Examples

pois_pal_grad("cool", n_steps = 4)

---

discrete colour scale constructor for poisson colours

Description

discrete colour scale constructor for poisson colours

Usage

scale_colour_disc_poisson(
  ...,
  palette = getOption("poispalette.colours", "discrete"),
  order = NULL,
  reverse = FALSE
)

Arguments

...	Additional arguments passed to discrete_scale()
palette	Character name of palette in pois_palettes
order	A numeric or character vector indicating the order of colours in the palette. Can be a subset.
reverse	Boolean indicating whether the palette should be reversed

Value

A ggplot2 discrete scale.

Examples

library(ggplot2)
ggplot(points, aes(RandomX, RandomY, colour = ID)) +
  geom_point() +
  scale_colour_disc_poisson()

---

gradient colour scale constructor for poisson colours

Description

gradient colour scale constructor for poisson colours

Usage

scale_colour_grad_poisson(
  ...,
  palette = getOption("poispalette.gradient", "cool"),
  reverse = FALSE,
  n_steps = 256,
  n_col = getOption("poispalette.n_col", NULL)
)

Arguments

...	Additional arguments passed to scale_color_gradientn()
palette	Character name of palette in pois_palettes, or selection of colour names from pois_cols
reverse	Boolean indicating whether the palette should be reversed
n_steps	Number of steps in gradient
n_col	Number of colours to subset from the palette (optional)

Value

A ggplot2 continuous scale.

Examples

library(ggplot2)
ggplot(points, aes(X, Y, colour = RandomX)) +
  geom_point() +
  scale_colour_grad_poisson(palette = "cool")

---

discrete fill scale constructor for poisson colours

Description

discrete fill scale constructor for poisson colours

Usage

scale_fill_disc_poisson(
  ...,
  palette = getOption("poispalette.colours", "discrete"),
  order = NULL,
  reverse = FALSE
)

Arguments

...	Additional arguments passed to discrete_scale()
palette	Character name of palette in pois_palettes
order	A numeric or character vector indicating the order of colours in the palette. Can be a subset.
reverse	Boolean indicating whether the palette should be reversed

Value

A ggplot2 discrete scale.

Examples

library(ggplot2)
ggplot(points, aes(RandomX, RandomY, fill = ID)) +
  geom_point(shape = 21) +
  scale_fill_disc_poisson()

---

Gradient fill scale constructor for poisson colours

Description

Gradient fill scale constructor for poisson colours

Usage

scale_fill_grad_poisson(
  ...,
  palette = getOption("poispalette.gradient", "cool"),
  reverse = FALSE,
  n_steps = 256,
  n_col = getOption("poispalette.n_col", NULL)
)

Arguments

...	Additional arguments passed to scale_color_gradientn()
palette	Character name of palette in pois_palettes, or selection of colour names from pois_cols
reverse	Boolean indicating whether the palette should be reversed
n_steps	Number of steps in gradient
n_col	Number of colours to subset from the palette (optional)

Value

A ggplot2 continuous scale.

Examples

library(ggplot2)
ggplot(points, aes(X, Y, fill = RandomX)) +
  geom_point(shape = 21) +
  scale_fill_grad_poisson(palette = "cool")

---