Skip to content

Commit

Permalink
Force error if tab title starts with a numeral (#125)
Browse files Browse the repository at this point in the history
* Force error if tab_title starts with a numeral, doc, test

* Note that leading-numeral tab titles will errorin vignette
  • Loading branch information
matt-dray authored Mar 27, 2024
1 parent b4a43a8 commit 06604c9
Show file tree
Hide file tree
Showing 7 changed files with 107 additions and 18 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: a11ytables
Title: Create Spreadsheet Publications Following Best Practice
Version: 0.3.0.9001
Version: 0.3.1
Authors@R: c(
person(given = "Matt", family = "Dray", role = c("aut", "cre"), email = "mwdray@gmail.com"),
person(given = "Tim", family = "Taylor", role = "ctb"),
Expand Down
3 changes: 2 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# a11ytables 0.3.0.9001
# a11ytables 0.3.1

* Bug fix: make it an error if tab names are started with a numeric value (#124).
* Reduce gif file size, include additional frame (#121).

# a11ytables 0.3.0
Expand Down
7 changes: 4 additions & 3 deletions R/a11ytable.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
#'
#' @param tab_titles Required character vector, one value per sheet. Each title
#' will appear literally on each tab of the final spreadsheet output. Keep
#' brief. Letters and numbers only; use underscores for spaces. For example:
#' 'Cover', 'Contents', 'Notes', 'Table_1'. Will be corrected automatically
#' if non-conforming.
#' brief. Letters and numbers only; do not start with a number; use
#' underscores for spaces. For example: 'Cover', 'Contents', 'Notes',
#' 'Table_1'. Will be corrected automatically unless there's an error.
#' @param sheet_types Required character vector, one value per sheet. Sheets
#' that don't contain publication tables ('meta' sheets) should be of type
#' 'contents', 'cover' or 'notes'. Sheets that contain statistical tables of
Expand Down Expand Up @@ -210,6 +210,7 @@ create_a11ytable <- function(
as_a11ytable <- function(x) {

if (any(names(x) %in% "tab_title")) {
.check_tab_titles(x[["tab_title"]])
x[["tab_title"]] <- .clean_tab_titles(x[["tab_title"]])
}

Expand Down
16 changes: 16 additions & 0 deletions R/utils-a11ytable.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
#' Clean Sheet Tab Titles
#' @param tab_titles Character vector. Names of tabs in the workbook.
#' @noRd
.check_tab_titles <- function(tab_titles) {

tab_title_num_start <- grep("^\\d", unlist(tab_titles))

if (length(tab_title_num_start) > 0) {
stop(
"Elements in tab_titles must not begin with a numeral (change ",
.vector_to_sentence(tab_titles[tab_title_num_start]), ").",
call. = FALSE
)
}

}

#' Clean Sheet Tab Titles
#' @param tab_titles Character vector. Names of tabs in the workbook.
Expand Down
6 changes: 3 additions & 3 deletions man/create_a11ytable.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

89 changes: 80 additions & 9 deletions tests/testthat/test-a11ytable.R
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,44 @@ test_that("absence of note sheets doesn't prevent a11ytable formation", {

})

test_that("tab_titles with starting numeral will error", {

demo_df[demo_df$tab_title == "Table_2", "tab_title"] <- "2_Table"

expect_error(
with(
demo_df,
create_a11ytable(
tab_titles = tab_title,
sheet_types = sheet_type,
sheet_titles = sheet_title,
tables = table
)
),
"Elements in tab_titles must not begin with a numeral \\(change 2_Table\\)\\."
)

})

test_that("non-conforming tab_titles are cleaned", {

expect_warning(
create_a11ytable(
tab_titles = c("cover", "contents", "Table 2"),
sheet_types = c("cover", "contents", "tables"),
sheet_titles = c("Cover", "Contents", "Table"),
source = "Source",
tables = list(
demo_df[["table"]][[1]],
demo_df[["table"]][[2]][3, ],
mtcars
)
),
"These tab_titles have been cleaned automatically: Table 2 \\(now Table_2\\)"
)

})

test_that("tab_titles are unique", {

demo_df[demo_df$tab_title == "Table_2", "tab_title"] <- "Table_1"
Expand Down Expand Up @@ -317,21 +355,54 @@ test_that("period added to end of text if needed", {

test_that("tab titles are cleaned and warnings provided", {

long_title <- "12345678901234567890123456789012"
long_title <- "X12345678901234567890123456789012"

expect_warning(.clean_tab_titles("Table 1"))
expect_warning(.clean_tab_titles(c("Table 1", "Table 2")))
expect_warning(.clean_tab_titles(c("Table_1", "Table 2")))
expect_warning(.clean_tab_titles("Table!@£#$%^&*(){}[]-=+;:'\"\\|<>,.~`/?1"))
expect_warning(.clean_tab_titles(long_title))
expect_warning(
.clean_tab_titles("Table 1"),
"These tab_titles have been cleaned automatically: Table 1 \\(now Table_1\\)\\."
)

expect_warning(
.clean_tab_titles(c("Table 1", "Table 2")),
"These tab_titles have been cleaned automatically: Table 1, Table 2 \\(now Table_1, Table_2\\)\\."
)

expect_warning(
.clean_tab_titles(c("Table_1", "Table 2")),
"These tab_titles have been cleaned automatically: Table 2 \\(now Table_2\\)\\."
)

expect_warning(
.clean_tab_titles("Table!@£#$%^&*(){}[]-=+;:'\"\\|<>,.~`/?1"),
"These tab_titles have been cleaned automatically:.+now Table1\\)\\."
)

expect_warning(
.clean_tab_titles(long_title),
"These tab_titles have been cleaned automatically: X12345678901234567890123456789012 \\(now X123456789012345678901234567890\\)\\."
)

x <- demo_df
x[1, "tab_title"] <- long_title
expect_warning(as_a11ytable(x))

y <- demo_df
y[1, "tab_title"] <- "Cover!"
expect_warning(as_a11ytable(y))
x <- demo_df
x[1, "tab_title"] <- "Cover!"
expect_warning(as_a11ytable(x))

x <- demo_df
x["tab_title"][5, ] <- long_title
expect_warning(
.warn_a11ytable(x),
"Each tab_title must be shorter than 31 characters."
)

x <- demo_df
x["tab_title"][5, ] <- "Table-1!"
expect_warning(
.warn_a11ytable(x),
"Each tab_title must contain only letters, numbers or underscores."
)

})

Expand Down
2 changes: 1 addition & 1 deletion vignettes/a11ytables.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ my_a11ytable <-
)
```

The function will return errors or warnings if anything is missing or seems odd. For example, we were warned that a value we supplied to `tab_title` had to be cleaned from 'Table 1' to 'Table_1', since blank spaces are not allowed in tab names.
The function will return errors or warnings if anything is missing or seems odd. For example, we were warned that a value we supplied to `tab_title` had to be cleaned from 'Table 1' to 'Table_1', since blank spaces are not allowed in tab names. Note that there will be an error if there are any tab titles that start with a numeral.

Here's a preview of the object that was created:

Expand Down

0 comments on commit 06604c9

Please sign in to comment.