-
Notifications
You must be signed in to change notification settings - Fork 80
/
augment_rows.R
1177 lines (1067 loc) · 34.5 KB
/
augment_rows.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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#' @title Change headers labels
#'
#' @description This function set labels for specified
#' columns in the bottom row header of a flextable.
#'
#' @param x a `flextable` object
#' @param ... named arguments (names are data colnames), each element is a single character
#' value specifying label to use.
#' @param values a named list (names are data colnames), each element is a single character
#' value specifying label to use. If provided, argument `...` will be ignored.
#' It can also be a unamed character vector, in that case, it must have the same
#' length than the number of columns of the flextable.
#' @examples
#' ft <- flextable(head(iris))
#' ft <- set_header_labels(ft,
#' Sepal.Length = "Sepal length",
#' Sepal.Width = "Sepal width", Petal.Length = "Petal length",
#' Petal.Width = "Petal width"
#' )
#'
#' ft <- flextable(head(iris))
#' ft <- set_header_labels(ft,
#' values = list(
#' Sepal.Length = "Sepal length",
#' Sepal.Width = "Sepal width",
#' Petal.Length = "Petal length",
#' Petal.Width = "Petal width"
#' )
#' )
#' ft
#'
#' ft <- flextable(head(iris))
#' ft <- set_header_labels(
#' x = ft,
#' values = c(
#' "Sepal length",
#' "Sepal width", "Petal length",
#' "Petal width", "Species")
#' )
#' ft
#' @export
#' @family functions for row and column operations in a flextable
set_header_labels <- function(x, ..., values = NULL) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "set_header_labels()"))
}
if (is.null(values)) {
values <- list(...)
if (nrow_part(x, "header") < 1) {
stop("there is no header row to be replaced")
}
}
names_ <- names(values)
if (is.null(names_)) {
if (length(values) != ncol_keys(x)) {
stop("if unamed, the labels must have the same length than col_keys.")
}
newcontent <- as_paragraph(as_chunk(values))
newcontent <- as_chunkset_struct(
l_paragraph = newcontent,
keys = x$col_keys)
x$header$content <- set_chunkset_struct_element(
x = x$header$content,
i = nrow_part(x, "header"),
j = x$col_keys,
value = newcontent
)
} else {
names_ <- names_[names_ %in% x$col_keys]
values <- values[names_]
if (length(values) < 1) {
return(x)
}
newcontent <- lapply(
values,
function(x) {
as_paragraph(as_chunk(x, formatter = format_fun.default))
}
)
newcontent <- as_chunkset_struct(
l_paragraph = do.call(c, newcontent),
keys = names_)
x$header$content <- set_chunkset_struct_element(
x = x$header$content,
i = nrow_part(x, "header"),
j = names_,
value = newcontent
)
}
x
}
#' @export
#' @title Delete flextable part
#'
#' @description indicate to not print a part of
#' the flextable, i.e. an header, footer or the body.
#'
#' @param x a `flextable` object
#' @param part partname of the table to delete (one of 'body', 'header' or 'footer').
#' @family functions for row and column operations in a flextable
#' @examples
#' ft <- flextable(head(iris))
#' ft <- delete_part(x = ft, part = "header")
#' ft
delete_part <- function(x, part = "header") {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "delete_part()"))
}
part <- match.arg(part, c("body", "header", "footer"), several.ok = FALSE)
nrow_ <- nrow(x[[part]]$dataset)
x[[part]] <- complex_tabpart(
data = x[[part]]$dataset[-seq_len(nrow_), , drop = FALSE],
col_keys = x$col_keys,
cwidth = x[[part]]$colwidths, cheight = x[[part]]$rowheights
)
x
}
delete_rows_from_part <- function(x, i) {
# dataset rows
x$dataset <- x$dataset[-i, ]
# heights
x$rowheights <- x$rowheights[-i]
# hrules
x$hrule <- x$hrule[-i]
# spans
x$spans$rows <- x$spans$rows[-i, , drop = FALSE]
x$spans$columns <- x$spans$columns[-i, , drop = FALSE]
x <- span_free(x)
# styles
x$styles$cells <- delete_style_row(x$styles$cells, i)
x$styles$pars <- delete_style_row(x$styles$pars, i)
x$styles$text <- delete_style_row(x$styles$text, i)
# content
x$content <- delete_row_from_fpstruct(x$content, i)
x
}
#' @export
#' @title Delete flextable rows
#'
#' @description The function removes one or more rows
#' from a 'flextable'.
#' @details
#' Deleting one or more rows will result in the deletion
#' of any span parameters that may have been set previously.
#' They will have to be redone after this operation or
#' performed only after this deletion.
#' @param x a `flextable` object
#' @param i rows selection
#' @param part partname of the table (one of 'all', 'body', 'header', 'footer')
#' @family functions for row and column operations in a flextable
#' @examples
#' ft <- flextable(head(iris))
#' ft <- delete_rows(ft, i = 1:5, part = "body")
#' ft
delete_rows <- function(x, i = NULL, part = "body") {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "delete_rows()"))
}
part <- match.arg(part, c("all", "body", "header", "footer"), several.ok = FALSE)
if (part == "all") {
for (p in c("header", "body", "footer")) {
x <- delete_rows(x = x, i = i, part = p)
}
return(x)
}
if (nrow_part(x, part) < 1) {
return(x)
}
check_formula_i_and_part(i, part)
i <- get_rows_id(x[[part]], i)
if (length(i) < 1) {
return(x)
}
x[[part]] <- delete_rows_from_part(x[[part]], i = i)
x
}
delete_colums_from_part <- function(x, j) {
# heights
x$colwidths <- x$colwidths[!x$col_keys %in% j]
# spans
x$spans$rows <- x$spans$rows[, !x$col_keys %in% j, drop = FALSE]
x$spans$columns <- x$spans$columns[, !x$col_keys %in% j, drop = FALSE]
x <- span_free(x)
# styles
x$styles$cells <- delete_style_col(x$styles$cells, j)
x$styles$pars <- delete_style_col(x$styles$pars, j)
x$styles$text <- delete_style_col(x$styles$text, j)
# content
x$content <- delete_col_from_fpstruct(x$content, j)
x$col_keys <- x$content$keys
x
}
#' @export
#' @title Delete flextable columns
#'
#' @description The function removes one or more columns
#' from a 'flextable'.
#' @details
#' Deleting one or more columns will result in the deletion
#' of any span parameters that may have been set previously.
#' They will have to be redone after this operation or
#' performed only after this deletion.
#' @param x a `flextable` object
#' @param j columns selection
#' @family functions for row and column operations in a flextable
#' @examples
#' ft <- flextable(head(iris))
#' ft <- delete_columns(ft, j = "Species")
#' ft
delete_columns <- function(x, j = NULL) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "delete_columns()"))
}
cols <- NULL
parts <- c("header", "body", "footer")
for (part in parts) {
if (nrow_part(x, part) > 0) {
if (is.null(cols)) {
cols <- get_columns_id(x[[part]], j)
cols <- x$col_keys[cols]
}
x[[part]] <- delete_colums_from_part(x[[part]], j = cols)
}
}
x$col_keys <- setdiff(x$col_keys, cols)
x
}
as_new_data <- function(x, ..., values = NULL) {
if (is.null(values)) {
values <- list(...)
} else if (is.atomic(values)) {
values <- as.list(values)
}
if (!is.list(values)) {
stop("argument 'values' must be a list")
}
args_ <- lapply(x$col_keys, function(x, n) rep(NA, n), n = length(values[[1]]))
names(args_) <- x$col_keys
args_[names(values)] <- values
data.frame(as.list(args_), check.names = FALSE, stringsAsFactors = FALSE)
}
add_rows_to_tabpart <- function(x, rows, first = FALSE) {
data <- x$dataset
spans <- x$spans
ncol <- length(x$col_keys)
nrow <- nrow(rows)
x$styles$cells <- add_rows_to_struct(x$styles$cells, nrows = nrow, first = first)
x$styles$pars <- add_rows_to_struct(x$styles$pars, nrows = nrow, first = first)
x$styles$text <- add_rows_to_struct(x$styles$text, nrows = nrow, first = first)
x$content <- add_rows_to_chunkset_struct(x$content, nrows = nrow, first = first, rows)
span_new <- matrix(1, ncol = ncol, nrow = nrow)
rowheights <- x$rowheights
hrule <- x$hrule
if (!first) {
data <- rbind(data, rows)
spans$rows <- rbind(spans$rows, span_new)
spans$columns <- rbind(spans$columns, span_new)
rowheights <- c(rowheights, rep(rev(rowheights)[1], nrow(rows)))
hrule <- c(hrule, rep(rev(hrule)[1], nrow(rows)))
} else {
data <- rbind(rows, data)
spans$rows <- rbind(span_new, spans$rows)
spans$columns <- rbind(span_new, spans$columns)
rowheights <- c(rep(rowheights[1], nrow(rows)), rowheights)
hrule <- c(rep(hrule[1], nrow(rows)), hrule)
}
x$rowheights <- rowheights
x$dataset <- data
x$spans <- spans
x$hrule <- hrule
x
}
# add header/footer content ----
#' @export
#' @title Add column values as new lines in body
#'
#' @description
#' The function adds a list of values to be inserted as
#' new rows in the body. The values are inserted in
#' existing columns of the input data of the flextable.
#' Rows can be inserted at the top or the bottom of
#' the body.
#'
#' If some columns are not provided, they will be replaced by
#' `NA` and displayed as empty.
#' @param x a flextable object
#' @param top should the rows be inserted at the top or the bottom.
#' @param ... named arguments (names are data colnames) of values
#' to add. It is important to insert data of the same type as the
#' original data, otherwise it will be transformed (probably
#' into strings if you add a `character` where a `double` is expected).
#' This makes possible to still format cell contents with the `colformat_*`
#' functions, for example [colformat_num()].
#' @param values a list of name-value pairs of labels or values,
#' names should be existing col_key values. This argument can be used
#' instead of `...` for programming purpose (If `values` is
#' supplied argument `...` is ignored).
#' @examples
#' ft <- flextable(head(iris),
#' col_keys = c(
#' "Species", "Sepal.Length", "Petal.Length",
#' "Sepal.Width", "Petal.Width"
#' )
#' )
#'
#' ft <- add_body(
#' x = ft, Sepal.Length = 1:5,
#' Sepal.Width = 1:5 * 2, Petal.Length = 1:5 * 3,
#' Petal.Width = 1:5 + 10, Species = "Blah", top = FALSE
#' )
#'
#' ft <- theme_booktabs(ft)
#' ft
#' @family functions for row and column operations in a flextable
#' @seealso [flextable()]
add_body <- function(x, top = TRUE, ..., values = NULL) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_body()"))
}
new_data <- as_new_data(x = x, ..., values = values)
x$body <- add_rows_to_tabpart(x$body, new_data, first = top)
x
}
#' @export
#' @title Add column values as new lines in header
#'
#' @description
#' The function adds a list of values to be inserted as
#' new rows in the header. The values are inserted in
#' existing columns of the input data of the flextable.
#' Rows can be inserted at the top or the bottom of
#' the header.
#'
#' If some columns are not provided, they will be replaced by
#' `NA` and displayed as empty.
#'
#' \if{html}{\out{
#' <img src="https://www.ardata.fr/img/flextable-imgs/flextable-016.png" alt="add_header illustration" style="width:100\%;">
#' }}
#'
#' @note
#' when repeating values, they can be merged together with
#' function [merge_h()] and [merge_v()].
#' @inheritParams add_body
#' @examples
#' library(flextable)
#'
#' fun <- function(x) {
#' paste0(
#' c("min: ", "max: "),
#' formatC(range(x))
#' )
#' }
#' new_row <- list(
#' Sepal.Length = fun(iris$Sepal.Length),
#' Sepal.Width = fun(iris$Sepal.Width),
#' Petal.Width = fun(iris$Petal.Width),
#' Petal.Length = fun(iris$Petal.Length)
#' )
#'
#' ft_1 <- flextable(data = head(iris))
#' ft_1 <- add_header(ft_1, values = new_row, top = FALSE)
#' ft_1 <- append_chunks(ft_1, part = "header", i = 2, )
#' ft_1 <- theme_booktabs(ft_1, bold_header = TRUE)
#' ft_1 <- align(ft_1, align = "center", part = "all")
#' ft_1
#' @family functions for row and column operations in a flextable
add_header <- function(x, top = TRUE, ..., values = NULL) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_header()"))
}
header_data <- as_new_data(x = x, ..., values = values)
x$header <- add_rows_to_tabpart(x$header, header_data, first = top)
x
}
#' @export
#' @title Add column values as new lines in footer
#'
#' @description
#' The function adds a list of values to be inserted as
#' new rows in the footer. The values are inserted in
#' existing columns of the input data of the flextable.
#' Rows can be inserted at the top or the bottom of
#' the footer.
#'
#' If some columns are not provided, they will be replaced by
#' `NA` and displayed as empty.
#' @inheritParams add_body
#' @examples
#' new_row <- as.list(colMeans(iris[, -5]))
#' new_row$Species <- "Means"
#'
#' formatter <- function(x) sprintf("%.1f", x)
#'
#' ft <- flextable(data = head(iris))
#' ft <- add_footer(ft, values = new_row)
#'
#' # cosmetics
#' ft <- compose(
#' x = ft, j = 1:4,
#' value = as_paragraph(
#' as_chunk(., formatter = formatter)
#' ),
#' part = "footer", use_dot = TRUE
#' )
#' ft <- align(ft, part = "footer", align = "right", j = 1:4)
#' ft
#' @family functions for row and column operations in a flextable
add_footer <- function(x, top = TRUE, ..., values = NULL) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_footer()"))
}
footer_data <- as_new_data(x = x, ..., values = values)
if (nrow_part(x, "footer") < 1) {
x$footer <- complex_tabpart(data = footer_data, col_keys = x$col_keys, cwidth = .75, cheight = .25)
} else {
x$footer <- add_rows_to_tabpart(x$footer, footer_data, first = top)
}
x
}
# add spanned labels as a single row ----
#' @export
#' @title Add body labels
#'
#' @description Add a row of new columns labels in body part.
#' Labels can be spanned along multiple columns, as merged cells.
#'
#' Labels are associated with a number of columns
#' to merge that default to one if not specified.
#' In this case, you have to make sure that the
#' number of labels is equal to the number of columns displayed.
#'
#' The function can add only one single row by call.
#'
#' Labels can also be formatted with [as_paragraph()].
#'
#' @param x a flextable object
#' @param top should the row be inserted at the top or the bottom.
#' @param values values to add. It can be a `list`, a `character()` vector
#' or a call to [as_paragraph()].
#'
#' If it is a list, it can be a named list with the names of the columns of the
#' original data.frame or the `colkeys`; this is the recommended method because
#' it allows to keep the original data types and therefore allows to perform
#' conditional formatting. If a character, columns of the original data.frame
#' stored in the flextable object are changed to `character()`; this is often
#' not an issue with footer and header but can be inconvenient if adding
#' rows into body as it will change data types to character and prevent
#' efficient conditional formatting.
#'
#' @param colwidths the number of columns to merge in the row for each label
#'
#' @examples
#' library(flextable)
#'
#' ft01 <- fp_text_default(color = "red")
#' ft02 <- fp_text_default(color = "orange")
#'
#' pars <- as_paragraph(
#' as_chunk(c("(1)", "(2)"), props = ft02), " ",
#' as_chunk(
#' c(
#' "My tailor is rich",
#' "My baker is rich"
#' ),
#' props = ft01
#' )
#' )
#'
#' ft_1 <- flextable(head(mtcars))
#' ft_1 <- add_body_row(ft_1,
#' values = pars,
#' colwidths = c(5, 6), top = FALSE
#' )
#' ft_1 <- add_body_row(ft_1,
#' values = pars,
#' colwidths = c(3, 8), top = TRUE
#' )
#' ft_1 <- theme_box(ft_1)
#' ft_1
#'
#' ft_2 <- flextable(head(airquality))
#' ft_2 <- add_body_row(ft_2,
#' values = c("blah", "bleeeh"),
#' colwidths = c(4, 2), top = TRUE
#' )
#' ft_2 <- theme_box(ft_2)
#' ft_2
#' @family functions for row and column operations in a flextable
#' @seealso [flextable()], [set_caption()]
add_body_row <- function(x, top = TRUE, values = list(), colwidths = integer(0)) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_body_row()"))
}
if (length(colwidths) < 1) {
colwidths <- rep(1L, length(x$col_keys))
}
if (sum(colwidths) != length(x$col_keys)) {
stop(sprintf(
"sum of colwidths elements must be equal to the number of col_keys: %.0f.",
length(x$col_keys)
))
}
if (is.atomic(values)) {
values <- as.list(values)
}
row_span <- unlist(lapply(colwidths, function(x) {
z <- integer(x)
z[1] <- x
z
}))
col_j <- which(row_span > 0)
body_data <- x$body$dataset[nrow(x$body$dataset) + 1, ]
if (inherits(values, "paragraph")) {
} else if (!is.null(attr(values, "names"))) {
body_data[, names(values)] <- values
} else {
body_data[, which(row_span > 0)] <- values
}
if (nrow_part(x, "body") < 1) {
x$body <- complex_tabpart(
data = body_data, col_keys = x$col_keys,
cwidth = dim(x)$widths, cheight = .25
)
} else {
x$body <- add_rows_to_tabpart(x$body, body_data, first = top)
}
i <- ifelse(top, 1, nrow_part(x, "body"))
x$body$spans$rows[i, ] <- row_span
if (inherits(values, "paragraph")) {
for (j in seq_along(col_j)) {
x <- mk_par(x, i = i, j = col_j[j], value = values[j], part = "body")
}
}
x
}
#' @export
#' @title Add header labels
#'
#' @description Add a row of new columns labels in header part.
#' Labels can be spanned along multiple columns, as merged cells.
#'
#' Labels are associated with a number of columns
#' to merge that default to one if not specified.
#' In this case, you have to make sure that the
#' number of labels is equal to the number of columns displayed.
#'
#' The function can add only one single row by call.
#'
#' Labels can also be formatted with [as_paragraph()].
#'
#' @param x a flextable object
#' @param top should the row be inserted at the
#' top or the bottom. Default to TRUE.
#' @param values values to add, a character vector (as header rows
#' contains only character values/columns), a list
#' or a call to [as_paragraph()].
#' @param colwidths the number of columns used for each label
#' @examples
#' library(flextable)
#'
#' ft01 <- fp_text_default(color = "red")
#' ft02 <- fp_text_default(color = "orange")
#'
#' pars <- as_paragraph(
#' as_chunk(c("(1)", "(2)"), props = ft02), " ",
#' as_chunk(c(
#' "My tailor is rich",
#' "My baker is rich"
#' ), props = ft01)
#' )
#'
#' ft_1 <- flextable(head(mtcars))
#' ft_1 <- add_header_row(ft_1,
#' values = pars,
#' colwidths = c(5, 6), top = FALSE
#' )
#' ft_1 <- add_header_row(ft_1,
#' values = pars,
#' colwidths = c(3, 8), top = TRUE
#' )
#' ft_1
#'
#' ft_2 <- flextable(head(airquality))
#' ft_2 <- add_header_row(ft_2,
#' values = c("Measure", "Time"),
#' colwidths = c(4, 2), top = TRUE
#' )
#' ft_2 <- theme_box(ft_2)
#' ft_2
#' @family functions for row and column operations in a flextable
#' @seealso [flextable()], [set_caption()]
add_header_row <- function(x, top = TRUE, values = character(0), colwidths = integer(0)) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_header_row()"))
}
if (length(colwidths) < 1) {
colwidths <- rep(1L, length(x$col_keys))
}
if (sum(colwidths) != length(x$col_keys)) {
stop(sprintf(
"sum of colwidths elements must be equal to the number of col_keys: %.0f.",
length(x$col_keys)
))
}
if (inherits(values, "paragraph")) {
str_values <- vapply(values, function(x) paste0(x$txt, collapse = ""), FUN.VALUE = "")
} else {
str_values <- values
}
header_data <- data_from_char(values = str_values, colwidths = colwidths, col_keys = x$col_keys)
if (nrow_part(x, "header") < 1) {
x$header <- complex_tabpart(data = header_data, col_keys = x$col_keys, cwidth = dim(x)$widths, cheight = .25)
} else {
x$header <- add_rows_to_tabpart(x$header, header_data, first = top)
}
row_span <- unlist(lapply(colwidths, function(x) {
z <- integer(x)
z[1] <- x
z
}))
i <- ifelse(top, 1, nrow(x$header$dataset))
x$header$spans$rows[i, ] <- row_span
if (inherits(values, "paragraph")) {
if (top) {
i <- 1
} else {
i <- nrow_part(x, "header")
}
col_j <- which(row_span > 0)
for (j in seq_along(col_j)) {
x <- mk_par(x, i = i, j = col_j[j], value = values[j], part = "header")
}
}
x
}
#' @export
#' @title Add footer labels
#'
#' @description Add a row of new columns labels in footer part.
#' Labels can be spanned along multiple columns, as merged cells.
#'
#' Labels are associated with a number of columns
#' to merge that default to one if not specified.
#' In this case, you have to make sure that the
#' number of labels is equal to the number of columns displayed.
#'
#' The function can add only one single row by call.
#'
#' Labels can be formatted with [as_paragraph()].
#' @inheritParams add_body_row
#' @family functions for row and column operations in a flextable
#' @seealso [flextable()], [set_caption()]
#' @examples
#' library(flextable)
#'
#' ft01 <- fp_text_default(color = "red")
#' ft02 <- fp_text_default(color = "orange")
#'
#' pars <- as_paragraph(
#' as_chunk(c("(1)", "(2)"), props = ft02), " ",
#' as_chunk(
#' c(
#' "My tailor is rich",
#' "My baker is rich"
#' ),
#' props = ft01
#' )
#' )
#'
#' ft_1 <- flextable(head(mtcars))
#' ft_1 <- add_footer_row(ft_1,
#' values = pars,
#' colwidths = c(5, 6), top = FALSE
#' )
#' ft_1 <- add_footer_row(ft_1,
#' values = pars,
#' colwidths = c(3, 8), top = TRUE
#' )
#' ft_1
#'
#' ft_2 <- flextable(head(airquality))
#' ft_2 <- add_footer_row(ft_2,
#' values = c("Measure", "Time"),
#' colwidths = c(4, 2), top = TRUE
#' )
#' ft_2 <- theme_box(ft_2)
#' ft_2
add_footer_row <- function(x, top = TRUE, values = character(0), colwidths = integer(0)) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_footer_row()"))
}
if (sum(colwidths) != length(x$col_keys)) {
stop(sprintf(
"`colwidths` argument specify room for %.0f columns but %.0f are expected.",
sum(colwidths), length(x$col_keys)
))
}
if (is.atomic(values)) {
values <- as.list(values)
}
if (inherits(values, "paragraph")) {
str_values <- vapply(values, function(x) paste0(x$txt, collapse = ""), FUN.VALUE = "")
} else {
str_values <- values
}
footer_data <- data_from_char(values = str_values, colwidths = colwidths, col_keys = x$col_keys)
if (nrow_part(x, "footer") < 1) {
x$footer <- complex_tabpart(data = footer_data, col_keys = x$col_keys, cwidth = dim(x)$widths, cheight = .25)
} else {
x$footer <- add_rows_to_tabpart(x$footer, footer_data, first = top)
}
row_span <- unlist(lapply(colwidths, function(x) {
z <- integer(x)
z[1] <- x
z
}))
i <- ifelse(top, 1, nrow_part(x, "footer"))
x$footer$spans$rows[i, ] <- row_span
col_j <- which(row_span > 0)
if (inherits(values, "paragraph")) {
for (j in seq_along(col_j)) {
x <- mk_par(x, i = i, j = col_j[j], value = values[j], part = "footer")
}
}
x
}
data_from_char <- function(values, colwidths, col_keys) {
if (is.list(values)) {
values <- as.character(unlist(values))
} else if (!is.atomic(values)) {
stop("'values' must be an atomic vector or a list.")
}
values_ <- inverse.rle(structure(list(lengths = colwidths, values = values), class = "rle"))
values_ <- as.list(values_)
names(values_) <- col_keys
as.data.frame(values_, check.names = FALSE, stringsAsFactors = FALSE)
}
# add labels as spanned rows ----
#' @export
#' @title Add labels as new rows in the header
#'
#' @description Add labels as new rows in the header,
#' where all columns are merged.
#'
#' This is a sugar function to be used when you need to
#' add labels in the header, most of the time it will
#' be used to adding titles on the top rows of the flextable.
#'
#' @param x a `flextable` object
#' @param values a character vector or a call to [as_paragraph()]
#' to get formated content, each element will
#' be added as a new row.
#' @param top should the row be inserted at the top
#' or the bottom. Default to TRUE.
#' @family functions that add rows in the table
#' @examples
#' # ex 1----
#' ft_1 <- flextable(head(iris))
#' ft_1 <- add_header_lines(ft_1, values = "blah blah")
#' ft_1 <- add_header_lines(ft_1, values = c("blah 1", "blah 2"))
#' ft_1 <- autofit(ft_1)
#' ft_1
#'
#' # ex 2----
#' ft01 <- fp_text_default(color = "red")
#' ft02 <- fp_text_default(color = "orange")
#' ref <- c("(1)", "(2)")
#' pars <- as_paragraph(
#' as_chunk(ref, props = ft02), " ",
#' as_chunk(rep("My tailor is rich", length(ref)), props = ft01)
#' )
#'
#' ft_2 <- flextable(head(mtcars))
#' ft_2 <- add_header_lines(ft_2, values = pars, top = FALSE)
#' ft_2 <- add_header_lines(ft_2, values = ref, top = TRUE)
#' ft_2 <- add_footer_lines(ft_2, values = "blah", top = TRUE)
#' ft_2 <- add_footer_lines(ft_2, values = pars, top = TRUE)
#' ft_2 <- add_footer_lines(ft_2, values = ref, top = FALSE)
#' ft_2 <- autofit(ft_2)
#' ft_2
add_header_lines <- function(x, values = character(0), top = TRUE) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_header_lines()"))
}
values_map <- values
if (top) values_map <- rev(values_map)
if (inherits(values, "paragraph")) {
for (ivalue in seq_len(length(values_map))) {
x <- add_header_row(x, values = "", colwidths = length(x$col_keys), top = top)
if (top) {
i <- 1
} else {
i <- nrow_part(x, "header")
}
x <- mk_par(x, i = i, j = 1, value = values_map[ivalue], part = "header")
}
} else {
for (value in values_map) {
x <- add_header_row(x, values = value, colwidths = length(x$col_keys), top = top)
}
}
x
}
#' @export
#' @title Add labels as new rows in the footer
#'
#' @description Add labels as new rows in the footer,
#' where all columns are merged.
#'
#' This is a sugar function to be used when you need to
#' add labels in the footer, a footnote for example.
#' @inheritParams add_header_lines
#' @family functions for row and column operations in a flextable
#' @examples
#' ft_1 <- flextable(head(iris))
#' ft_1 <- add_footer_lines(ft_1,
#' values = c("blah 1", "blah 2")
#' )
#' ft_1
add_footer_lines <- function(x, values = character(0), top = FALSE) {
if (!inherits(x, "flextable")) {
stop(sprintf("Function `%s` supports only flextable objects.", "add_footer_lines()"))
}
ivalues <- seq_len(length(values))
if (top) {
ivalues <- rev(ivalues)
}
if (inherits(values, "paragraph")) {
for (ivalue in ivalues) {
x <- add_footer_row(x, values = "", colwidths = length(x$col_keys), top = top)
if (top) {
i <- 1
} else {
i <- nrow_part(x, "footer")
}
x <- mk_par(x, i = i, j = 1, value = values[ivalue], part = "footer")
}
} else {
for (ivalue in ivalues) {
x <- add_footer_row(x,
values = values[ivalue],
colwidths = length(x$col_keys), top = top
)
}
}
x
}
# add header/footer with reference table ----
set_part_df <- function(x, mapping = NULL, key = "col_keys", part) {
keys <- data.frame(
col_keys = x$col_keys,
stringsAsFactors = FALSE
)
names(keys) <- key
part_data <- merge(keys, mapping, by = key, all.x = TRUE, all.y = FALSE, sort = FALSE)
part_data <- part_data[match(keys[[key]], part_data[[key]]), ]
part_data[[key]] <- NULL
part_data <- do.call(rbind, part_data)
dimnames(part_data) <- NULL
part_data <- as.data.frame(part_data, stringsAsFactors = FALSE)
names(part_data) <- x$col_keys
if (length(x$blanks)) {
blank_ <- character(nrow(part_data))
replace_ <- lapply(x$blanks, function(x, bl) bl, blank_)
names(replace_) <- x$blanks
part_data[x$blanks] <- replace_
}
colwidths <- x[[part]]$colwidths
x[[part]] <- eval(
call(
class(x[[part]]),
data = part_data,
col_keys = x$col_keys,
cwidth = .75, cheight = .25
)
)
cheight <- optimal_sizes(x[[part]])$heights
x[[part]]$colwidths <- colwidths
x[[part]]$rowheights <- cheight
x
}
#' @export
#' @rdname set_header_footer_df
#' @name set_header_footer_df
#' @title Set flextable's header or footer rows
#'
#' @description Use a data.frame to specify flextable's header or footer rows.
#'
#' The data.frame must contain a column whose values match flextable
#' `col_keys` argument, this column will be used as join key. The
#' other columns will be displayed as header or footer rows. The leftmost column
#' is used as the top header/footer row and the rightmost column
#' is used as the bottom header/footer row.
#'
#' @param x a `flextable` object
#' @param mapping a `data.frame` specyfing for each colname
#' content of the column.
#' @param key column to use as key when joigning data_mapping.
#' @examples