Package 'okcolors'

Title: A Set of Color Palettes Inspired by OK Go Music Videos for 'ggplot2' in R
Description: A collection of aesthetically appealing color palettes for effective data visualization with 'ggplot2'. Palettes support both discrete and continuous data.
Authors: Nelson de O. Quesado Filho [aut, cre], Ana Flávia Teles Silveira [aut]
Maintainer: Nelson de O. Quesado Filho <[email protected]>
License: GPL-3
Version: 0.1.1
Built: 2026-05-13 05:41:42 UTC
Source: https://github.com/nelsonquesado/okcolors

Help Index


Retrieve a Color Palette from the okcolors package

Description

Returns a vector of 'n' colors from a specified palette included in the okcolors package.

Usage

okcolors(palette = "obsession", n = 5, direction = 1)

Arguments

palette

Character. Name of the palette to use. One of '"it"', '"stone"', '"skyscrapers"', '"obsession"', or '"moment"'. Default is '"obsession"'.

n

Integer. Number of colors to return. Default is '5'.

direction

Integer. If '1' (default), returns the palette as is. If '-1', reverses the order.

Value

A character vector of hex color codes of length 'n'.

Examples

okcolors("stone", 3)
okcolors("obsession", 7, direction = -1)

Custom ggplot2 Color Scale using okcolors Palettes

Description

Applies a custom discrete or continuous color scale to ggplot2 plots using a selected palette from the okcolors package.

Usage

scale_color_okcolors(
  palette = "obsession",
  discrete = TRUE,
  direction = 1,
  ...
)

Arguments

palette

Character. Name of the palette to use. Must be one of the palettes available in 'okcolors()'. Default is '"obsession"'.

discrete

Logical. Whether to use a discrete scale ('TRUE') or a continuous scale ('FALSE'). Default is 'TRUE'.

direction

Integer. If '1' (default), colors are as defined. If '-1', the palette is reversed.

...

Additional arguments passed to 'ggplot2::discrete_scale()' or 'ggplot2::scale_color_gradientn()'.

Value

A 'Scale' object that can be added to a ggplot2 plot.


Custom ggplot2 Fill Scale using okcolors Palettes

Description

Applies a custom discrete or continuous fill scale to ggplot2 plots using a selected palette from the okcolors package.

Usage

scale_fill_okcolors(palette = "obsession", discrete = TRUE, direction = 1, ...)

Arguments

palette

Character. Name of the palette to use. Must be one of the palettes available in 'okcolors()'. Default is '"obsession"'.

discrete

Logical. Whether to use a discrete scale ('TRUE') or a continuous scale ('FALSE'). Default is 'TRUE'.

direction

Integer. If '1' (default), colors are as defined. If '-1', the palette is reversed.

...

Additional arguments passed to 'ggplot2::discrete_scale()' or 'ggplot2::scale_fill_gradientn()'.

Value

A 'Scale' object that can be added to a ggplot2 plot.


List Available Palettes in the okcolors Package

Description

Returns a character vector of all valid palette names supported by the 'okcolors' package.

Usage

valid_palettes()

Value

A character vector with the names of available palettes.

Examples

valid_palettes()