https://github.com/matt-dray/a11ytables

R package: generate best-practice stats spreadsheets for publication
https://github.com/matt-dray/a11ytables

accessibility openxlsx reproducible-analytical-pipeline rstats rstats-package spreadsheet uk-gov-data-science

Last synced: 4 days ago
JSON representation

R package: generate best-practice stats spreadsheets for publication

• Host: GitHub
• URL: https://github.com/matt-dray/a11ytables
• Owner: matt-dray
• License: other
• Created: 2021-08-19T10:42:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T14:08:58.000Z (8 months ago)
• Last Synced: 2025-01-26T10:58:01.476Z (5 days ago)
• Topics: accessibility, openxlsx, reproducible-analytical-pipeline, rstats, rstats-package, spreadsheet, uk-gov-data-science
• Language: R
• Homepage: https://co-analysis.github.io/a11ytables/
• Size: 8.06 MB
• Stars: 43
• Watchers: 2
• Forks: 3
• Open Issues: 21
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# {a11ytables} 

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![CRAN

status](https://www.r-pkg.org/badges/version/a11ytables)](https://CRAN.R-project.org/package=a11ytables)

[![R-CMD-check](https://github.com/co-analysis/a11ytables/workflows/R-CMD-check/badge.svg)](https://github.com/co-analysis/a11ytables/actions)

[![Codecov test

coverage](https://codecov.io/gh/co-analysis/a11ytables/branch/main/graph/badge.svg)](https://codecov.io/gh/co-analysis/a11ytables?branch=main)

## Purpose

An R package to help automatically create reproducible spreadsheets that adhere to the guidance on [releasing statistics in spreadsheets](https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/) from the UK government's [Analysis Function](https://analysisfunction.civilservice.gov.uk/), with a focus on accessibility ('a11y').

Visit [the {a11ytables} website](https://co-analysis.github.io/a11ytables/) for documentation.

## Accessibility

This package is not yet capable of creating perfectly accessible spreadsheets but will help with the bulk of the work needed. Users of this packages should refer back to [the main spreadsheet guidance](https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/) or [the spreadsheet accessibility checklist](https://analysisfunction.civilservice.gov.uk/policy-store/making-spreadsheets-accessible-a-brief-checklist-of-the-basics/) after using it to make sure nothing has been missed. Please email [[email protected]](mailto:[email protected]) if you use the package so they can monitor use and the outputs produced.

## Contribute

The package is under (opinionated) active development. Please see [the NEWS file](https://co-analysis.github.io/a11ytables/news/index.html) for the latest changes. 

To contribute, please add [an issue](https://github.com/co-analysis/a11ytables/issues) or [a pull request](https://github.com/co-analysis/a11ytables/pulls) after reading [the code of conduct](https://github.com/co-analysis/a11ytables/blob/main/CODE_OF_CONDUCT.md) and [contributing](https://github.com/co-analysis/a11ytables/blob/main/.github/CONTRIBUTING.md) guidance. 

## Install

Install the package [from GitHub](https://github.com/co-analysis/a11ytables) using [{remotes}](https://remotes.r-lib.org/).

```{r install, eval=FALSE}

install.packages("remotes")  # if not already installed

remotes::install_github(

  repo = "co-analysis/a11ytables",  # GitHub user/repository

  dependencies = TRUE,              # install required/suggested packages

  build_vignettes = TRUE            # generate vignette documentation

)

library(a11ytables)  # attach package

```

If you need an earlier version of the package, you should replace the `repo` argument call with, for example, `"co-analysis/[email protected]"` for the version 0.1.0 release.

The package depends on [{openxlsx}](https://ycphs.github.io/openxlsx/) and [{pillar}](https://pillar.r-lib.org/), which are also installed with {a11ytables}.

## Use

To create a spreadsheet:

1. Use `create_a11ytable()`

1. Pass the output to `generate_workbook()`

1. Pass the output to `openxlsx::saveWorkbook()`

Run `?function_name` or visit [the package website](https://co-analysis.github.io/a11ytables/reference/index.html) for function documentation. For long-form documentation, [visit the package website](https://co-analysis.github.io/a11ytables/) or run `browseVignettes("a11ytables")` to read the:

* [introductory vignette](https://co-analysis.github.io/a11ytables/articles/a11ytables.html) to get started

* [accessbility checklist vignette](https://co-analysis.github.io/a11ytables/articles/checklist.html) to see how the package complies with best-practice guidance

* [terminology vignette](https://co-analysis.github.io/a11ytables/articles/terminology) to understand the nomenclature of spreadsheet terms as used in this package

* [package structure vignette](https://co-analysis.github.io/a11ytables/articles/structure) to see how the package works under the hood

This package also includes [an RStudio Addin](https://rstudio.github.io/rstudioaddins/) that inserts pre-filled demo skeletons of the {a11ytables} workflow.

## Related projects

The ONS's Analysis Standards and Pipelines team has released [a Python package called 'gptables'](https://github.com/best-practice-and-impact/gptables). {a11ytables} is an independent effort that offers a native R solution that is very similar to gptables in its outputs, though there are some differences in implementation. You can always use gptables in R [via the {reticulate} package](https://gptables.readthedocs.io/en/latest/usage.html#r-usage) if you prefer.

{a11ytables} can help you fulfil a [Reproducible Analytical Pipeline](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/) by automating the generation of compliant spreadsheets for publication.

## Code of Conduct

Please note that the {a11ytables} project is released with a [Contributor Code of Conduct](https://co-analysis.github.io/a11ytables/CODE_OF_CONDUCT.html).

## Copyright and Licensing

© Crown Copyright, 2023, Cabinet Office.

This work is [Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/). The source code for the software is released under the MIT licence as per the the [UK Government Licensing Framework](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/open-government-licence/open-software-licences/) and the [GDS Way licensing guidance](https://gds-way.cloudapps.digital/manuals/licensing.html). The documentation for the software is released under the [Open Government Licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).