forked from mtennekes/cols4all
-
Notifications
You must be signed in to change notification settings - Fork 0
/
c4a_palettes.Rd
48 lines (41 loc) · 1.56 KB
/
c4a_palettes.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/c4a_palettes.R
\docType{data}
\name{c4a_palettes}
\alias{c4a_palettes}
\alias{c4a_series}
\alias{.P}
\title{Get available palette names and series}
\format{
An object of class \code{environment} of length 16.
}
\usage{
c4a_palettes(
type = c("all", "cat", "seq", "div"),
series = NULL,
full.names = TRUE
)
c4a_series(type = c("all", "cat", "seq", "div"))
.P
}
\arguments{
\item{type}{type of color palette: one of \code{"all"} (all palettes), \code{"cat"} (categorical/qualitative palettes), \code{"seq"} (sequential palettes) and \code{"div"} (diverging palettes).}
\item{series}{series to list the palettes from. Run \code{c4a_series} to see the options.}
\item{full.names}{should full names, i.e. with the prefix "series."? By default \code{TRUE}.}
}
\value{
names of the loaded color palettes
}
\description{
\code{c4a_palettes} lists all available cols4all color palettes. Palettes are organized by series. The available series are listed with \code{c4a_series}. Palettes are also organized per functional type, where we currently support: categorical \code{"cat"}, sequential \code{"seq"}, and diverging \code{"div"}" palette types. In an IDE with auto-completion (such as RStudio) it is possible to browse through the palette names with \code{.P} (using \code{$} like in lists).
}
\examples{
c4a_palettes()
c4a_series()
c4a_palettes(type = "cat", series = "tol")
c4a_palettes(type = "seq", series = "kovesi")
}
\seealso{
References of the palettes: \code{\link{cols4all-package}}.
}
\keyword{datasets}