diff --git a/R/tab_remove.R b/R/tab_remove.R
index 4201780fbb..1d5c8cfaf7 100644
--- a/R/tab_remove.R
+++ b/R/tab_remove.R
@@ -301,7 +301,8 @@ rm_spanners <- function(
as.integer(
resolve_vector_i(
expr = {{ spanners }},
- vector = spanners_tbl[["spanner_id"]]
+ vector = spanners_tbl[["spanner_id"]],
+ "spanner"
)
)
@@ -498,7 +499,8 @@ rm_footnotes <- function(
as.integer(
resolve_vector_i(
expr = {{ footnotes }},
- vector = as.character(seq_len(footnotes_count))
+ vector = as.character(seq_len(footnotes_count)),
+ "footnote"
)
)
@@ -649,7 +651,8 @@ rm_source_notes <- function(
as.integer(
resolve_vector_i(
expr = {{ source_notes }},
- vector = as.character(seq_len(source_notes_length))
+ vector = as.character(seq_len(source_notes_length)),
+ "source note"
)
)
diff --git a/tests/testthat/_snaps/tab_remove.md b/tests/testthat/_snaps/tab_remove.md
index daaffe948e..fe735eb100 100644
--- a/tests/testthat/_snaps/tab_remove.md
+++ b/tests/testthat/_snaps/tab_remove.md
@@ -103,6 +103,20 @@
Output
[1] "\n \n \n | \n year | \n bdy_style | \n hp | \n hp_rpm | \n trq | \n trq_rpm | \n mpg_c | \n mpg_h | \n msrp | \n
\n \n \n | GT | \n2017 | \ncoupe | \n647 | \n6250 | \n550 | \n5900 | \n11 | \n18 | \n447000 |
|---|
\n | 458 Speciale | \n2015 | \ncoupe | \n597 | \n9000 | \n398 | \n6000 | \n13 | \n17 | \n291744 |
|---|
\n | 458 Spider | \n2015 | \nconvertible | \n562 | \n9000 | \n398 | \n6000 | \n13 | \n17 | \n263553 |
|---|
\n | 458 Italia | \n2014 | \ncoupe | \n562 | \n9000 | \n398 | \n6000 | \n13 | \n17 | \n233509 |
|---|
\n | 488 GTB | \n2016 | \ncoupe | \n661 | \n8000 | \n561 | \n3000 | \n15 | \n22 | \n245400 |
|---|
\n | California | \n2015 | \nconvertible | \n553 | \n7500 | \n557 | \n4750 | \n16 | \n23 | \n198973 |
|---|
\n | GTC4Lusso | \n2017 | \ncoupe | \n680 | \n8250 | \n514 | \n5750 | \n12 | \n17 | \n298000 |
|---|
\n | FF | \n2015 | \ncoupe | \n652 | \n8000 | \n504 | \n6000 | \n11 | \n16 | \n295000 |
|---|
\n \n \n \n
"
+---
+
+ Code
+ t_sp <- exibble %>% gt() %>% tab_spanner("span1", columns = c(char, fctr))
+ rm_spanners(t_sp, "span2")
+ Condition
+ Error in `rm_spanners()`:
+ ! Can't find spanner `span2` in the data.
+ Code
+ rm_spanners(t_sp, c("span1", "span2", "span3"))
+ Condition
+ Error in `rm_spanners()`:
+ ! Can't find spanners `span2` and `span3` in the data.
+
# Table footnotes can be removed using `rm_footnotes()`
Code
@@ -131,6 +145,26 @@
Output
[1] "\n \n \n | num | \n char | \n fctr | \n date | \n time | \n datetime | \n currency | \n row | \n group | \n
\n \n \n | 1.111e-01 | \napricot | \none | \n2015-01-15 | \n13:35 | \n2018-01-01 02:22 | \n49.950 | \nrow_1 | \ngrp_a |
\n | 2.222e+00 | \nbanana | \ntwo | \n2015-02-15 | \n14:40 | \n2018-02-02 14:33 | \n17.950 | \nrow_2 | \ngrp_a |
\n | 3.333e+01 | \ncoconut | \nthree | \n2015-03-15 | \n15:45 | \n2018-03-03 03:44 | \n1.390 | \nrow_3 | \ngrp_a |
\n | 4.444e+02 | \ndurian | \nfour | \n2015-04-15 | \n16:50 | \n2018-04-04 15:55 | \n65100.000 | \nrow_4 | \ngrp_a |
\n | 5.550e+03 | \nNA | \nfive | \n2015-05-15 | \n17:55 | \n2018-05-05 04:00 | \n1325.810 | \nrow_5 | \ngrp_b |
\n | NA | \nfig | \nsix | \n2015-06-15 | \nNA | \n2018-06-06 16:11 | \n13.255 | \nrow_6 | \ngrp_b |
\n | 7.770e+05 | \ngrapefruit | \nseven | \nNA | \n19:10 | \n2018-07-07 05:22 | \nNA | \nrow_7 | \ngrp_b |
\n | 8.880e+06 | \nhoneydew | \neight | \n2015-08-15 | \n20:20 | \nNA | \n0.440 | \nrow_8 | \ngrp_b |
\n \n \n \n
"
+---
+
+ Code
+ t_ft <- exibble %>% gt() %>% tab_footnote(footnote = "Footnote 1", locations = cells_body(
+ 1, 1)) %>% tab_footnote(footnote = "Footnote 2", locations = cells_body(1, 2))
+ t_ft %>% rm_footnotes(footnotes = 0:1)
+ Condition
+ Error in `rm_footnotes()`:
+ ! The following footnote indices do not exist in the data: 0.
+ Code
+ t_ft %>% rm_footnotes(footnotes = 2:3)
+ Condition
+ Error in `rm_footnotes()`:
+ ! The following footnote indices do not exist in the data: 3.
+ Code
+ t_ft %>% rm_footnotes(footnotes = 3)
+ Condition
+ Error in `rm_footnotes()`:
+ ! The following footnote indices do not exist in the data: 3.
+
# Table source notes can be removed using `rm_source_notes()`
Code
@@ -159,3 +193,23 @@
Output
[1] "\n \n \n | num | \n char | \n fctr | \n date | \n time | \n datetime | \n currency | \n row | \n group | \n
\n \n \n | 1.111e-01 | \napricot | \none | \n2015-01-15 | \n13:35 | \n2018-01-01 02:22 | \n49.950 | \nrow_1 | \ngrp_a |
\n | 2.222e+00 | \nbanana | \ntwo | \n2015-02-15 | \n14:40 | \n2018-02-02 14:33 | \n17.950 | \nrow_2 | \ngrp_a |
\n | 3.333e+01 | \ncoconut | \nthree | \n2015-03-15 | \n15:45 | \n2018-03-03 03:44 | \n1.390 | \nrow_3 | \ngrp_a |
\n | 4.444e+02 | \ndurian | \nfour | \n2015-04-15 | \n16:50 | \n2018-04-04 15:55 | \n65100.000 | \nrow_4 | \ngrp_a |
\n | 5.550e+03 | \nNA | \nfive | \n2015-05-15 | \n17:55 | \n2018-05-05 04:00 | \n1325.810 | \nrow_5 | \ngrp_b |
\n | NA | \nfig | \nsix | \n2015-06-15 | \nNA | \n2018-06-06 16:11 | \n13.255 | \nrow_6 | \ngrp_b |
\n | 7.770e+05 | \ngrapefruit | \nseven | \nNA | \n19:10 | \n2018-07-07 05:22 | \nNA | \nrow_7 | \ngrp_b |
\n | 8.880e+06 | \nhoneydew | \neight | \n2015-08-15 | \n20:20 | \nNA | \n0.440 | \nrow_8 | \ngrp_b |
\n \n \n \n | Source Note 1 | \n
\n \n \n
"
+---
+
+ Code
+ t_sn <- exibble %>% gt() %>% tab_source_note(source_note = "Source Note 1") %>%
+ tab_source_note(source_note = "Source Note 2")
+ t_sn %>% rm_source_notes(source_notes = 0:1)
+ Condition
+ Error in `rm_source_notes()`:
+ ! The following source note indices do not exist in the data: 0.
+ Code
+ t_sn %>% rm_source_notes(2:3)
+ Condition
+ Error in `rm_source_notes()`:
+ ! The following source note indices do not exist in the data: 3.
+ Code
+ t_sn %>% rm_source_notes(3)
+ Condition
+ Error in `rm_source_notes()`:
+ ! The following source note indices do not exist in the data: 3.
+
diff --git a/tests/testthat/test-tab_remove.R b/tests/testthat/test-tab_remove.R
index b7089f6464..80ec16b735 100644
--- a/tests/testthat/test-tab_remove.R
+++ b/tests/testthat/test-tab_remove.R
@@ -526,27 +526,14 @@ test_that("Spanner column labels can be removed using `rm_spanners()`", {
# Expect an error if the `spanners` vector contains ID values that
# don't exist for any spanner column labels
- expect_error(
- gtcars %>%
- dplyr::select(
- -mfr, -trim, bdy_style, drivetrain,
- -drivetrain, -trsmn, -ctry_origin
- ) %>%
- dplyr::slice(1:8) %>%
- gt(rowname_col = "model") %>%
- tab_spanner(label = "HP", columns = c(hp, hp_rpm)) %>%
- tab_spanner(label = "Torque", columns = c(trq, trq_rpm)) %>%
- tab_spanner(label = "MPG", columns = c(mpg_c, mpg_h)) %>%
- tab_spanner(
- label = "Performance",
- columns = c(
- hp, hp_rpm, trq, trq_rpm,
- mpg_c, mpg_h
- )
- ) %>%
- rm_spanners(spanners = c("HP", "perf")) %>%
- render_as_html()
- )
+ expect_snapshot(error = TRUE, {
+ t_sp <- exibble %>%
+ gt() %>%
+ tab_spanner("span1", columns = c(char, fctr))
+
+ rm_spanners(t_sp, "span2")
+ rm_spanners(t_sp, c("span1", "span2", "span3"))
+ })
})
test_that("Table footnotes can be removed using `rm_footnotes()`", {
@@ -605,26 +592,16 @@ test_that("Table footnotes can be removed using `rm_footnotes()`", {
# Expect an error when providing any integer values that don't correspond
# with the available footnotes ([1, 2])
- expect_error(
- exibble %>%
+ expect_snapshot(error = TRUE, {
+ t_ft <- exibble %>%
gt() %>%
tab_footnote(footnote = "Footnote 1", locations = cells_body(1, 1)) %>%
- tab_footnote(footnote = "Footnote 2", locations = cells_body(1, 2)) %>%
- rm_footnotes(footnotes = 0:1)
- )
- expect_error(
- exibble %>%
- gt() %>%
- tab_footnote(footnote = "Footnote 1", locations = cells_body(1, 1)) %>%
- tab_footnote(footnote = "Footnote 2", locations = cells_body(1, 2)) %>%
- rm_footnotes(footnotes = 2:3)
- )
- expect_error(
- exibble %>%
- gt() %>%
- tab_footnote(footnote = "Footnote 1", locations = cells_body(1, 1)) %>%
- rm_footnotes(footnotes = 2)
- )
+ tab_footnote(footnote = "Footnote 2", locations = cells_body(1, 2))
+ t_ft %>% rm_footnotes(footnotes = 0:1)
+ t_ft %>% rm_footnotes(footnotes = 2:3)
+ t_ft %>% rm_footnotes(footnotes = 3)
+ })
+
expect_no_error(
exibble %>%
gt() %>%
@@ -731,26 +708,17 @@ test_that("Table source notes can be removed using `rm_source_notes()`", {
# Expect an error when providing any integer values that don't correspond
# with the available source notes ([1, 2])
- expect_error(
- exibble %>%
+ expect_snapshot(error = TRUE, {
+ t_sn <- exibble %>%
gt() %>%
tab_source_note(source_note = "Source Note 1") %>%
- tab_source_note(source_note = "Source Note 2") %>%
- rm_source_notes(source_notes = 0:1)
- )
- expect_error(
- exibble %>%
- gt() %>%
- tab_source_note(source_note = "Source Note 1") %>%
- tab_source_note(source_note = "Source Note 2") %>%
- rm_source_notes(source_notes = 2:3)
- )
- expect_error(
- exibble %>%
- gt() %>%
- tab_source_note(source_note = "Source Note 1") %>%
- rm_source_notes(source_notes = 2)
- )
+ tab_source_note(source_note = "Source Note 2")
+
+ t_sn %>% rm_source_notes(source_notes = 0:1)
+ t_sn %>% rm_source_notes(2:3)
+ t_sn %>% rm_source_notes(3)
+ })
+
expect_no_error(
exibble %>%
gt() %>%