-
Notifications
You must be signed in to change notification settings - Fork 7
/
scales.R
253 lines (230 loc) · 6.46 KB
/
scales.R
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
#' UNHCR ggplot2 color scales
#'
#' UNHCR ggplot2 color scales
#'
#' @inheritParams scales::gradient_n_pal
#' @inheritParams ggplot2::continuous_scale
#' @inheritParams ggplot2::discrete_scale
#'
#' @param type One of \"sequential\", \"diverging\" or \"qualitative\"
#' @param palette If a string, will use that named palette. If a number, will
#' index into the list of palettes of appropriate `type`
#' @param direction Sets the order of colors in the scale. If 1, the default,
#' colors are as output by [unhcr_pal()]. If -1, the order of colors is reversed
#' @param nmax Maximum number of different colors the palette should contain. If not provided, is calculated automatically
#' from the data.
#' @param order Numeric vector listing the order in which the colors should be used. Default is \code{1:nmax}.
#' @param ... Other arguments passed on to [discrete_scale()] or
#' [continuous_scale()] to control name, limits, breaks, labels and so forth
#'
#' @importFrom scales gradient_n_pal
#'
#' @return A discrete, continuous or binned `Scale` object
#'
#' @examples
#' library(ggplot2)
#'
#' data(msleep, package = "ggplot2")
#'
#' ggplot(msleep, aes(vore, sleep_total, fill = vore)) +
#' geom_boxplot() +
#' scale_fill_unhcr_d(palette = 1, direction = -1)
#'
#' @rdname unhcr_scale
#' @export
scale_color_unhcr_c <- function(..., type = "sequential",
palette = 1,
direction = 1,
na.value = "#E9E9E9", guide = "colourbar") {
pal <- unhcr_pal_scale(
type = type,
palette = palette,
direction = direction
)(256)
continuous_scale("colour",
"unhcr_continuous",
gradient_n_pal(pal),
na.value = na.value,
guide = guide,
...
)
}
#' @rdname unhcr_scale
#' @export
scale_color_unhcr_d <- function(..., type = "qualitative",
palette = 1,
direction = 1,
nmax = NULL,
order = NULL,
na.value = "#E9E9E9") {
pal <- unhcr_pal_scale(
type = type,
palette = palette,
nmax = nmax,
order = order,
direction = direction
)
discrete_scale("colour",
"unhcr_discrete",
pal,
na.value = na.value,
...
)
}
#' @rdname unhcr_scale
#' @export
scale_color_unhcr_b <- function(..., type = "qualitative",
palette = 1,
direction = 1,
nmax = NULL,
order = NULL,
na.value = "#E9E9E9",
guide = "coloursteps") {
pal <- binned_pal(unhcr_pal_scale(
type = type,
palette = palette,
nmax = nmax,
order = order,
direction = direction
))
binned_scale("colour",
"unhcr_binned",
pal,
na.value = na.value,
guide = guide,
...
)
}
#' @rdname unhcr_scale
#' @aliases scale_color_unhcr_c
#' @export
scale_colour_unhcr_c <- scale_color_unhcr_c
#' @rdname unhcr_scale
#' @aliases scale_color_unhcr_d
#' @export
scale_colour_unhcr_d <- scale_color_unhcr_d
#' @rdname unhcr_scale
#' @aliases scale_color_unhcr_b
#' @export
scale_colour_unhcr_b <- scale_color_unhcr_b
#' @rdname unhcr_scale
#' @export
scale_fill_unhcr_c <- function(..., type = "sequential",
palette = 1,
direction = 1,
na.value = "#E9E9E9",
guide = "colourbar") {
pal <- unhcr_pal_scale(
type = type,
palette = palette,
direction = direction
)(256)
continuous_scale("fill",
"unhcr_continuous",
gradient_n_pal(pal),
na.value = na.value,
guide = guide,
...
)
}
#' @rdname unhcr_scale
#' @export
scale_fill_unhcr_d <- function(..., type = "qualitative",
palette = 1,
direction = 1,
nmax = NULL,
order = NULL,
na.value = "#E9E9E9") {
pal <- unhcr_pal_scale(
type = type,
palette = palette,
nmax = nmax,
order = order,
direction = direction
)
discrete_scale("fill",
"unhcr_discrete",
pal,
na.value = na.value,
...
)
}
#' @rdname unhcr_scale
#' @export
scale_fill_unhcr_b <- function(..., type = "qualitative",
palette = 1,
direction = 1,
nmax = NULL,
order = NULL,
na.value = "#E9E9E9",
guide = "coloursteps") {
pal <- binned_pal(unhcr_pal_scale(
type = type,
palette = palette,
nmax = nmax,
order = order,
direction = direction
))
binned_scale("fill",
"unhcr_binned",
pal,
na.value = na.value,
guide = guide,
...
)
}
#' @noRd
unhcr_pal_scale <- function(type = "qualitative",
nmax = NULL, order = NULL,
palette = 1, direction = 1) {
pal <- unhcr_pal_name(palette, type)
function(n) {
if (is.null(nmax) | type != "qualitative") {
nmax <- n
}
if (is.null(order) | type != "qualitative") {
order <- 1:n
}
if (n > nmax) {
warning("Insufficient values in scale_{color|fill}_unhcr_d. ",
n, " needed but only ",
nmax, " provided.",
call. = FALSE
)
}
# If <3 colors are requested, brewer.pal will return a 3-color palette and
# give a warning. This warning isn't useful, so suppress it.
# If the palette has k colors and >k colors are requested, brewer.pal will
# return a k-color palette and give a warning. This warning is useful, so
# don't suppress it.
if (nmax < 3) {
pal <- suppressWarnings(unhcr_pal(nmax, pal))
} else {
pal <- unhcr_pal(nmax, pal)
}
# In both cases ensure we have n items
pal <- pal[order]
if (direction == -1) {
pal <- rev(pal)
}
unname(pal)
}
}
#' @noRd
unhcr_pal_name <- function(palette, type) {
if (is.character(palette)) {
if (!palette %in% unhcrcolors$name) {
warning("Unknown palette ", palette)
palette <- "pal_blue"
}
return(palette)
}
type <- match.arg(type, unique(unhcrcolors$type))
unhcrcolors$name[unhcrcolors$type == type][palette]
}
#' @noRd
binned_pal <- function(palette) {
function(x) {
palette(length(x))
}
}