-
Notifications
You must be signed in to change notification settings - Fork 25
/
chart_data_styles.R
315 lines (264 loc) · 12.1 KB
/
chart_data_styles.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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
#' @export
#' @title Modify labels font settings
#' @description Specify mappings from levels in the data to displayed text font settings.
#' @param x an `ms_chart` object.
#' @param values a named list of [fp_text()] objects to map data labels to.
#' It is a named list, the values will be matched based on the names.
#' If it contains only one [fp_text()] object, it will be associated to all existing series.
#' @examples
#' library(officer)
#'
#' fp_text_settings <- list(
#' serie1 = fp_text(font.size = 7, color = "red"),
#' serie2 = fp_text(font.size = 0, color = "purple"),
#' serie3 = fp_text(font.size = 19, color = "wheat")
#' )
#'
#' barchart <- ms_barchart(
#' data = browser_data,
#' x = "browser", y = "value", group = "serie")
#' barchart <- chart_data_labels(barchart, show_val = TRUE)
#' barchart <- chart_labels_text( barchart,
#' values = fp_text_settings )
#' @family Series customization functions
chart_labels_text <- function(x, values){
serie_names <- names(x$series_settings$fill)
if( inherits(values, "fp_text") ){
values <- rep(list(values), length(serie_names) )
values <- setNames(values, serie_names)
}
if( is.null(values) || !is.list(values) || length(values) < 1 ){
stop("values must be a list of fp_text objects", call. = FALSE)
}
if( !all( sapply(values, inherits, what = "fp_text") ) ){
stop("values must be a list of fp_text objects", call. = FALSE)
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$labels_fp[names(values)] <- values
x
}
#' @export
#' @title Modify fill colour
#' @description Specify mappings from levels in the data to displayed fill colours.
#' @param x an `ms_chart` object.
#' @param values `character(num of series|1)`: a set of colours values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' If it contains only one colour, this colour will be associated to all existing series.
#' @examples
#' my_scatter <- ms_scatterchart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#' my_scatter <- chart_data_fill(my_scatter,
#' values = c(virginica = "#6FA2FF", versicolor = "#FF6161", setosa = "#81FF5B") )
#' @family Series customization functions
chart_data_fill <- function(x, values){
valid_cols <- is_valid_color(values)
if( any(!valid_cols) )
stop("invalid color(s) in argument values")
serie_names <- names(x$series_settings$fill)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$fill[names(values)] <- values
x
}
#' @export
#' @title Modify marker stroke colour
#' @description Specify mappings from levels in the data to displayed marker stroke colours.
#' @param x an `ms_chart` object.
#' @param values `character(num of series)`: a set of colours values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' If it contains only one colour, this colour will be associated to all existing series.
#' @examples
#' my_scatter <- ms_scatterchart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#' my_scatter <- chart_data_fill(my_scatter,
#' values = c(virginica = "#6FA2FF", versicolor = "#FF6161", setosa = "#81FF5B") )
#' my_scatter <- chart_data_stroke(my_scatter,
#' values = c(virginica = "black", versicolor = "black", setosa = "black") )
#' @family Series customization functions
chart_data_stroke <- function(x, values){
valid_cols <- is_valid_color(values)
if( any(!valid_cols) )
stop("invalid color(s) in argument values")
serie_names <- names(x$series_settings$colour)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$colour[names(values)] <- values
x
}
#' @export
#' @title Modify symbol
#' @description Specify mappings from levels in the data to displayed symbols.
#' @param x an `ms_chart` object.
#' @param values `character(num of series)`: a set of symbol values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' Possible values are: 'circle', 'dash', 'diamond', 'dot', 'none', 'plus',
#' 'square', 'star', 'triangle', 'x', 'auto'.
#' If it contains only one symbol, this symbol will be associated to all existing series.
#' @examples
#' my_scatter <- ms_scatterchart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#' my_scatter <- chart_data_fill(my_scatter,
#' values = c(virginica = "#6FA2FF", versicolor = "#FF6161", setosa = "#81FF5B") )
#' my_scatter <- chart_data_stroke(my_scatter,
#' values = c(virginica = "black", versicolor = "black", setosa = "black") )
#' my_scatter <- chart_data_symbol(my_scatter,
#' values = c(virginica = "circle", versicolor = "diamond", setosa = "circle") )
#' @family Series customization functions
chart_data_symbol <- function(x, values){
if( !all(values %in% st_markerstyle) ){
stop("values should have values matching ", paste0(shQuote(st_markerstyle), collapse = ", " ))
}
serie_names <- names(x$series_settings$symbol)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$symbol[names(values)] <- values
x
}
#' @export
#' @title Modify symbol size
#' @description Specify mappings from levels in the data to displayed size of symbols.
#' @param x an `ms_chart` object.
#' @param values `double(num of series)`: a set of size values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' If it contains only one size, this size will be associated to all existing series.
#' @examples
#' my_scatter <- ms_scatterchart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#' my_scatter <- chart_data_fill(my_scatter,
#' values = c(virginica = "#6FA2FF", versicolor = "#FF6161", setosa = "#81FF5B") )
#' my_scatter <- chart_data_stroke(my_scatter,
#' values = c(virginica = "black", versicolor = "black", setosa = "black") )
#' my_scatter <- chart_data_symbol(my_scatter,
#' values = c(virginica = "circle", versicolor = "diamond", setosa = "circle") )
#' my_scatter <- chart_data_size(my_scatter,
#' values = c(virginica = 20, versicolor = 16, setosa = 20) )
#' @family Series customization functions
chart_data_size <- function(x, values){
if( !is.numeric(values) )
stop("values should be numeric values")
if( any( sign(values) < 0 ) )
stop("values should not contain negative values")
serie_names <- names(x$series_settings$size)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$size[names(values)] <- values
x
}
#' @export
#' @title Modify line width
#' @description Specify mappings from levels in the data to displayed line width between symbols.
#' @param x an `ms_chart` object.
#' @param values `double(num of series)`: a set of size values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' If it contains only one size, this size will be associated to all existing series.
#' @examples
#' my_scatter <- ms_scatterchart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#' my_scatter <- chart_settings(my_scatter, scatterstyle = "lineMarker")
#' my_scatter <- chart_data_fill(my_scatter,
#' values = c(virginica = "#6FA2FF", versicolor = "#FF6161", setosa = "#81FF5B") )
#' my_scatter <- chart_data_stroke(my_scatter,
#' values = c(virginica = "black", versicolor = "black", setosa = "black") )
#' my_scatter <- chart_data_symbol(my_scatter,
#' values = c(virginica = "circle", versicolor = "diamond", setosa = "circle") )
#' my_scatter <- chart_data_size(my_scatter,
#' values = c(virginica = 20, versicolor = 16, setosa = 20) )
#' my_scatter <- chart_data_line_width(my_scatter,
#' values = c(virginica = 2, versicolor = 3, setosa = 6) )
#' @family Series customization functions
chart_data_line_width <- function(x, values){
if( !is.numeric(values) )
stop("values should be numeric values")
if( any( sign(values) < 0 ) )
stop("values should not contain negative values")
serie_names <- names(x$series_settings$line_width)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$line_width[names(values)] <- values
x
}
#' @export
#' @title Modify line style
#' @description Specify mappings from levels in the data to displayed line style.
#' @param x an `ms_chart` object.
#' @param values `character(num of series)`: a set of line style values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' Possible values are: 'none', 'solid', 'dashed', 'dotted'.
#' If it contains only one line style, this style will be associated to all existing series.
#' @examples
#' my_scatter <- ms_scatterchart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#' my_scatter <- chart_data_fill(my_scatter,
#' values = c(virginica = "#6FA2FF", versicolor = "#FF6161", setosa = "#81FF5B") )
#' my_scatter <- chart_data_stroke(my_scatter,
#' values = c(virginica = "black", versicolor = "black", setosa = "black") )
#' my_scatter <- chart_data_symbol(my_scatter,
#' values = c(virginica = "circle", versicolor = "diamond", setosa = "circle") )
#' my_scatter <- chart_data_line_style(my_scatter,
#' values = c(virginica = "solid", versicolor = "dotted", setosa = "dashed") )
#' @family Series customization functions
chart_data_line_style <- function(x, values){
if( !all(values %in% st_linestyle) ){
stop("values should have values matching ", paste0(shQuote(st_linestyle), collapse = ", " ))
}
serie_names <- names(x$series_settings$line_style)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$line_style[names(values)] <- values
x
}
#' @export
#' @title Smooth series
#' @description Specify mappings from levels in the data to smooth or not lines. This
#' feature only applies to [ms_linechart()].
#' @param x an `ms_chart` object.
#' @param values `integer(num of series)`: a set of smooth values to map data values to.
#' It is a named vector, the values will be matched based on the names.
#' Possible values are 0 or 1
#' If it contains only one integer it will be associated to all existing series.
#' @examples
#' linec <- ms_linechart(data = iris, x = "Sepal.Length",
#' y = "Sepal.Width", group = "Species")
#'linec <- chart_data_smooth(linec,
#' values = c(virginica = 0, versicolor = 0, setosa = 0) )
#' @family Series customization functions
chart_data_smooth <- function(x, values){
as_bool <- c(1,0)
if( !all(values %in% as_bool) ){
stop("smooth can only take values of 0 or 1")
}
serie_names <- names(x$series_settings$symbol)
if( length(values) == 1 ){
values <- rep(values, length(serie_names))
names(values) <- serie_names
}
if( !all(names(values) %in% serie_names ) )
stop( "values's names do not match series' names: ", paste0(shQuote(serie_names), collapse = ", "))
x$series_settings$smooth[names(values)] <- values
x
}