33 lines
1.1 KiB
R
33 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/color.R
|
|
\name{color}
|
|
\alias{color}
|
|
\alias{color_pattern}
|
|
\title{Helpers to extract defined colors as hex codes}
|
|
\usage{
|
|
color(..., unname = TRUE)
|
|
|
|
color_pattern(pattern, unname = TRUE)
|
|
}
|
|
\arguments{
|
|
\item{...}{Character names of colors. If NULL returns all colors.}
|
|
|
|
\item{unname}{Boolean. Should the output vector be unnamed? Default to `TRUE`.}
|
|
|
|
\item{pattern}{Pattern of the start of colors' name.}
|
|
}
|
|
\value{
|
|
Hex codes named or unnamed.
|
|
}
|
|
\description{
|
|
[color()] returns the requested columns, returns NA if absent. [color_pattern()] returns all colors that start with the pattern.
|
|
}
|
|
\section{Naming of colors}{
|
|
|
|
* All branding colors start with "branding";
|
|
* All , categorical colors start with ", cat_";
|
|
* All sequential colors start with "seq_";
|
|
|
|
Then, a number indi, cates the number of colors that belong to the palettes, a string the name of the palette, and, finally, a number the position of the color. E.g., "seq_5_red_4" would be the 4th color of a continuous palettes of 5 colors in the red band. Exception is made for white, light_grey, dark_grey, and black.
|
|
}
|
|
|