a11ytables v0.3.1

What's Changed

• Force error if tab title starts with a numeral by @matt-dray in #125
• Reduce demo outputs gif size by @matt-dray in #122

Full Changelog: v0.3.0...v0.3.1

a11ytables v0.3.0

What's Changed

• Allow arbitrary pre-table meta rows, bump to v0.3 by @matt-dray in #118
• Full changelog: v0.2.1...v0.3.0

From NEWS.md

Breaking changes

• The new custom_rows argument is the third-to-last argument to create_a11ytable() (it's been inserted before sources and tables) so that the argument order reflects the order of the pre-table rows that appear above tables in the spreadsheet output; this will be a problem for users of {a11ytables} before v0.3 who might have previously specified arguments by place rather than by name (I assume most will have specified arguments by name, so I expect this won't be much of a problem).

New features

• Added the custom_rows argument to the create_a11ytables() function to supply arbitrary sentences to separate rows above a table in contents, cover and notes sheets (#74).
• Allowed custom rows to be hyperlinks if the user provides them in Markdown-style (#74).
• Added the datasets demo_df ('data.frame' class) and demo_a11ytable ('a11ytables' class) to help demo the new custom_rows argument (and do a better job of showcasing other features of the package), superseding mtcars_df and mtcars_df2.

Bugfixes

• Adjusted Markdown-link detection in cases where the text portion contained parentheses (#119).
• Ensured the summary method printed table dimensions of cover list items (#79).

Documentation

• Updated {roxygen2} function documentation given the introduction of custom_rows.
• Updated vignettes to include detail on how to use custom_rows.
• Updated accessibility checklist vignette to include 'sensible column width' item (#117).

Miscellaneous

• Simplified the output of the summary method (#79).
• Updated tests to use demo_* datasets.
• Updated RStudio Addin given custom_rows and simplified to data.frame example only.
• Added internal .vector_to_sentence() function to help construct comma-separated lists from a vector.

a11ytables v0.2.1

What's Changed

Small, non-breaking updates only (thanks @jonathonmellor).

• Correct README spelling by @matt-dray in #112
• Use text not numeral for table count, bump to 0.2.1 by @matt-dray in #114

And remember, you can install the prior version of this package like:

remotes::install_github(
  repo = "co-analysis/a11ytables@v0.2.0", 
  dependencies = TRUE,
  build_vignettes = TRUE
)

Full Changelog: v0.2.0...v0.2.1

a11ytables v0.2.0

What's Changed

• Add Analysis Function references, contributing guide by @matt-dray in #84
• Correct documentation issues, update GitHub Actions by @matt-dray in #100
• Bump to v0.2 by @matt-dray in #104

New features:

• Allowed the cover information passed to create_a11ytable() to be supplied as a list rather than a data.frame, which means you can have an arbitrary number of rows under each section (#102).
• Allowed the user to supply links in Markdown format (e.g. [GOV.UK](https://www.gov.uk)) when passing the cover information to the tables argument of create_a11ytables() and when passing the data source reference to the source argument of create_a11ytables()(#47).
• Added an mtcars_df2 demo data set that contains a list input for the cover page, which itself contains Markdown-formatted hyperlinks.

Bugfixes:

• Ensured stringsAsFactors is set explicitly to FALSE in the data.frame call within create_a11ytable(), given that this default behaviour changed in R version 4 (#85).

And remember, you can install the prior version of this package like:

remotes::install_github(
  repo = "co-analysis/a11ytables@v0.1.0", 
  dependencies = TRUE,
  build_vignettes = TRUE
)

Full Changelog: v0.1.0...v0.2.0

a11ytables v0.1.0

This is the first non-developmental release of the package. 🎉

There are several breaking changes:

• Renamed the new_a11ytable() function to create_a11ytable() (#27)
• Renamed the create_a11y_wb() function to generate_workbook() and changed the main argument from 'content' to 'a11ytable' (#27)
• Removed the 'table_names' argument to create_a11ytable() and instead autogenerate them from the user-provided 'tab_title' (#61)
• Introduced the 'blank_cells' argument to create_a11ytable() so the user can provide a table-by-table reason for why cells might be empty (#62)
• Adjusted the in-built mtcars_df dataset to better fit the changes to the functions

See the NEWS file for the full changes—which include updated docs, tests and several (non-breaking) changes to the underlying code—or review them in the pull request.

Some users may have been using the package prior to these breaking changes. To install the last in-development version prior to v0.1.0:

# install.packages("remotes")  # if not already installed
remotes::install_github("co-analysis/a11ytables@v0.0.0.90015")

a11ytables v0.0.0.90015

The final WIP version of the package prior to v0.1. This release allows early-adopters to return to the developmental 'legacy' version of the package should they need to recreate any outputs, since v0.1 will have breaking changes. To install from GitHub:

# install.packages("remotes")  # if not already installed
remotes::install_github("co-analysis/a11ytables@v0.0.0.90015")