-
Notifications
You must be signed in to change notification settings - Fork 607
/
Copy pathcol.alpha.Rd
40 lines (37 loc) · 2.11 KB
/
col.alpha.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
\name{col.alpha}
\alias{col.alpha}\alias{col.desat}\alias{col.dist}\alias{grau}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{Color utility functions}
\description{
Functions for calculating transparent and desaturated colors.
}
\usage{
col.alpha( acol , alpha = 0.2 )
col.desat( acol , amt = 0.5 )
col.dist( x , mu = 0 , sd = 1 , col="slateblue" )
grau( alpha = 0.5 )
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{acol}{A color name or RGB color}
\item{alpha}{alpha transparency, where 1 means fully opaque and 0 fully transparent}
\item{amt}{amount of desaturation of color to apply, where 1 means totally desaturated (grayscale)}
\item{x}{A vector of values to use for calculating distances. See details below.}
\item{mu}{Value (or vector of values) to use for calculating distances}
\item{sd}{Standard deviation of distance function used to calculate transparency}
\item{col}{A color to apply transparency to, based on distance}
\item{alpha}{Transparency of black (used by \code{grau} function)}
}
\details{
These functions allow for calculating transparency and desaturation for colors. \code{col.alpha} makes a base color transparent, while \code{col.desat} makes a color have less saturation.
\code{col.dist} is used to make a list of transparent colors of differing alpha level. The levels are chosen based upon Gaussian distance from a chosen value, \code{mu}, with a chosen width of the function that determines how quickly colors become fully transparent, \code{sd}. For example, if \code{x} contains a column of data, then \code{col.dist} will return a vector of same length with transparency increasing as each value in \code{x} is distant from \code{mu}. This is useful for plotting data that emphasize points near some value or values.
\code{grau} simply returns a transparent version of black, producing effective gray values.
}
\references{}
\author{Richard McElreath}
\seealso{\code{\link{col2rgb}}, \code{\link{rgb2hsv}}, \code{\link{rgb}}}
\examples{
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\keyword{ }