From 791bb6659eb01dc6dbe70ef98c89be09c77968ab Mon Sep 17 00:00:00 2001 From: Matt Dray <18232097+matt-dray@users.noreply.github.com> Date: Mon, 4 Sep 2023 18:26:34 +0100 Subject: [PATCH] Reset repo, docs for a11ytables2 --- .Rbuildignore | 2 +- .gitignore | 53 ++++++- CODE_OF_CONDUCT.md | 4 +- DESCRIPTION | 14 +- LICENSE | 4 +- LICENSE.md | 2 +- NEWS.md | 131 +---------------- ...tables-package.R => a11ytables2-package.R} | 0 README.Rmd | 86 ----------- README.md | 139 ++---------------- a11ytables.Rproj => a11ytables2.Rproj | 0 man/a11ytables-package.Rd | 33 ----- man/a11ytables2-package.Rd | 32 ++++ tests/testthat.R | 4 +- 14 files changed, 107 insertions(+), 397 deletions(-) rename R/{a11ytables-package.R => a11ytables2-package.R} (100%) delete mode 100644 README.Rmd rename a11ytables.Rproj => a11ytables2.Rproj (100%) delete mode 100644 man/a11ytables-package.Rd create mode 100644 man/a11ytables2-package.Rd diff --git a/.Rbuildignore b/.Rbuildignore index 20dc1ea..281f56c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,4 +1,4 @@ -^a11ytables\.Rproj$ +^a11ytables2\.Rproj$ ^\.Rproj\.user$ ^data-raw$ ^README\.Rmd$ diff --git a/.gitignore b/.gitignore index ac84e5e..6999717 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,53 @@ -.Rproj.user +# History files .Rhistory +.Rapp.history + +# Session Data files .RData +.RDataTmp + +# User-specific files .Ruserdata -.Rprofile -.DS_Store -docs + +# Example code in package build process +*-Ex.R + +# Output files from R CMD build +/*.tar.gz + +# Output files from R CMD check +/*.Rcheck/ + +# RStudio files +.Rproj.user/ + +# produced vignettes +vignettes/*.html +vignettes/*.pdf + +# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 +.httr-oauth + +# knitr and R markdown default cache directories +*_cache/ +/cache/ + +# Temporary files created by R markdown +*.utf8.md +*.knit.md + +# R Environment Variables +.Renviron + +# pkgdown site +docs/ inst/doc + +# translation temp files +po/*~ + +# RStudio Connect folder +rsconnect/ + +# macOS +.DS_Store diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 9e4751b..dfe71f4 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,4 +1,4 @@ -# Code of Conduct for `a11ytables` +# Code of Conduct for `a11ytables2` Contributors to this repository hosted by `co-analysis` are expected to follow the Contributor Covenant Code of Conduct, and those working within Her Majesty's @@ -8,7 +8,7 @@ Government are also expected to follow the Civil Service Code. Where this Code of Conduct says: -- "Project", we mean this `a11ytables` GitHub repository; +- "Project", we mean this `a11ytables2` GitHub repository; - "Maintainer", we mean the `co-analysis` organisation owners; and - "Leadership", we mean both `co-analysis` organisation owners, line managers, and other leadership within the Cabinet Office. diff --git a/DESCRIPTION b/DESCRIPTION index 437c65f..428cdda 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ -Package: a11ytables +Package: a11ytables2 Title: Create Spreadsheet Publications Following Best Practice -Version: 0.1.0 +Version: 0.0.0.9000 Authors@R: c( person(given = "Crown Copyright", role = c("cph", "fnd")), person(given = "Matt", family = "Dray", role = c("aut", "cre"), email = "mwdray@gmail.com"), @@ -9,15 +9,15 @@ Authors@R: c( ) Description: Generate spreadsheet publications that follow best practice guidance from the UK government's Analysis Function Central Team, with a - focus on accessibility. Based on {openxlsx}. See also the Python package - 'gptables'. -URL: https://co-analysis.github.io/a11ytables/, https://github.com/co-analysis/a11ytables -BugReports: https://github.com/co-analysis/a11ytables/issues + focus on accessibility. Based on {openxlsx2}. Successor to 'a11ytables'. See + also the Python package 'gptables'. +URL: https://github.com/matt-dray/a11ytables2 +BugReports: https://github.com/matt-dray/a11ytables2/issues License: MIT + file LICENSE Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.3 Depends: R (>= 2.10) Imports: diff --git a/LICENSE b/LICENSE index 13e0478..b8982bd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,2 +1,2 @@ -YEAR: 2022 -COPYRIGHT HOLDER: 2022 Crown Copyright (Cabinet Office) +YEAR: 2023 +COPYRIGHT HOLDER: 2023 Crown Copyright (Cabinet Office) diff --git a/LICENSE.md b/LICENSE.md index aeb4e1b..0d69205 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2022 Crown Copyright (Cabinet Office) +Copyright (c) 2023 Crown Copyright (Cabinet Office) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/NEWS.md b/NEWS.md index e8345cb..80bb074 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,130 +1,3 @@ -# a11ytables 0.1.0 +# a11ytables2 0.0.9000 -## 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 - -## Docs - -* Added a vignette to provide an overview of the code underlying the package so that it's easier for developers to contribute (#58) -* Added a vignette to explain the terminology of a spreadsheet, as used in the package (#58) -* Refer to the updated gptables Python package and the best practice spreadsheet guidance on the Analysis Function website (#73) -* Add hex logo (#81) -* Updated README and other vignettes to reflect changes to the function API -* Corrected various typos - -## Miscellaneous - -* Increased test coverage (#63) -* Updated user-input sanitising: it now removes punctuation in 'tab_title', inserts underscores in place of spaces and adds full-stops to blank_cells and source data (#78) -* Consolidated all a11ytable-class-related functioning into `as_a11ytable()` so that `create_a11ytable()` only has to build a data.frame from supplied arguments and apply `as_a11ytable()` to it (#80) -* Added warning for user if the 'blank_cells' argument is provided to `create_a11ytable()` but there are no blank cells in the table, and vice versa -* Updated content of RStudio Addins to reflect function and argument changes -* Adjusted default column widths in notes and contents -* Renamed files in R/ for consistency and clarity -* Switched to `inherits()` for class detection in `if()` statements - -## Bugfixes - -* Provided a warning, rather than error, if you don't provide any 'source' argument to `create_a11ytable()`. - -# a11ytables 0.0.0.90015 - -* Added and improved warnings and errors (#34) -* Simplified the in-built dataset so it matches the 'get started' vignette -* Updated the gif used in the 'get started' vignette - -# a11ytables 0.0.0.90014 - -* Added explanations to the accessibility checklist vignette -* Converted the 'quickstart' vignette to 'get started', used a simpler example, added gif -* Removed the 'construct' vignette -* Used 'reference' in _pkgdown.yaml to better separate functions on the site - -# a11ytables 0.0.0.90013 - -* Added an RStudio Addin to insert code for an {a11ytables} workflow (#54) - -# a11ytables 0.0.0.90012 - -* Made source, notes and table insertion dynamic, so the row of insertion of each is dependent on the others (#33) -* Applied table styling based on dynamic table placement (#33) - -# a11ytables 0.0.0.90011 - -* Prevented the tab title being pasted into the titles of tables sheets (#48) -* Made sure to wrap non-header cells in tables sheets (#41) -* Provided an auto-column-width adjustment in tables where cell content or headers is long (#41) - -# a11ytables 0.0.0.90010 - -* Added warnings if issues are detected when making an a11ytables-class object (#34) -* Added a modified mtcars example dataset, `mtcars_df` (#20) -* Expunged `lfs_tables` (#20) -* Added 'Crown Copyright' to authors as the copyright holder -* Updated README and vignettes given these changes -* Added new quickstart vignette and simplified README (#43) -* Handled plurals and periods in meta sheet elements, update detection of notes in column headers - -# a11ytables 0.0.0.9009 - -* HOTFIX: corrected `.detect_notes()` so it actually works -* Converted the `print` method to a `summary` method, as suggested by @TimTaylor (#23) -* Imported {pillar} for {tibble}-style printing, as suggested by @TimTaylor (#26) -* Added @TimTaylor as a contributor -* Updated vignettes and README - -# a11ytables 0.0.0.9008 - -* Ensured numeric columns (even if they contain a string like '[c]' to indicate a suppressed value) are right-aligned (#32) -* Isolated out `.insert_*()` functions for table count and note presence from `.insert_prelim_a11y()`, for clarity - -# a11ytables 0.0.0.9007 - -* BREAKING CHANGE: removed subtables because they're not being used for now and are confusing -* Added the first draft vignettes on how to create an a11ytable and an accessibility guidance checklist (#22) - -# a11ytables 0.0.0.9006 - -* HOTFIX: fixed a problem where the `tab_title` was being used to filter when it should have been `sheet_type` - -# a11ytables 0.0.0.9005 - -* BREAKING CHANGE: the user-supplied table for the cover sheet should now be supplied as a tidy two-column data.frame with a row per subsection, with columns for the 'subsection title' and 'subsection body' -* Updated the `lfs_tables` and `lfs_subtables` example datasets given the above; for an example see `lfs_tables[lfs_tables$sheet_type == "cover", "table"][[1]]` - -# a11ytables 0.0.0.9004 - -* BREAKING CHANGE: switched to using the `sheet_type` column of an a11ytable-class object to infer the sheet type as 'cover', 'contents', 'notes' or 'tables' (replacing 'meta'); it's no longer the `tab_title` that serves this role (#18). -* Ensured styles and `.add_*()` now make internal references to `sheet_type` rather than `tab_title` - -# a11ytables 0.0.0.9003 - -* BREAKING CHANGE: retired fully the `add_*()` function family for building a workbook 'by hand', given the introduction of `create_a11y_wb()` -* Introduced S3 class 'a11ytable', including exported functions to generate (`new_a11ytable()`, `as_a11ytable()`) and test (`is_a11ytable()`) objects of this class - -# a11ytables 0.0.0.9002 - -* Simplified all `add_*()` functions to a single `create_a11y_wb()` function (moving towards #15), though `add_*()` functions are all still exported -* Split supplied data into two, with and without sub-table examples: `lfs_tables` and `lfs_subtables`, respectively -* Updated README to detail simplified approach - -# a11ytables 0.0.0.9001 - -* Added un-exported `.style_*()` utils functions to style worksheets (#1) -* Incorporated style functions into `add_*table()*` functions -* Updated README -* Added basic tests, defensive stops (#10, #11) -* Added GitHub Actions for RMD check, coverage and {pkgdown} (#7) -* Transferred ownership from matt-dray to co-analysis (#9) - -# a11ytables 0.0.0.9000 - -* Added a `NEWS.md`, `CODE_OF_CONDUCT.md`, `README.Rmd` -* Added exported `add_*()` functions to create different tab types (cover, contents, notes, tables) -* Added un-exported `.insert_*()` utils functions to insert within-sheet elements -* Added MIT license with `LICENSE.md` +* Amended package-level documentation from 'a11ytables' to 'a11ytables2' and reset versioning. diff --git a/R/a11ytables-package.R b/R/a11ytables2-package.R similarity index 100% rename from R/a11ytables-package.R rename to R/a11ytables2-package.R diff --git a/README.Rmd b/README.Rmd deleted file mode 100644 index 2834ff2..0000000 --- a/README.Rmd +++ /dev/null @@ -1,86 +0,0 @@ ---- -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 latest guidance on [releasing statistics in spreadsheets](https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/) from the UK government's [Analysis Function Central Team](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 intended for 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 [analysis.function@ons.gov.uk](mailto:analysis.function@ons.gov.uk) 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("co-analysis/a11ytables", build_vignettes = TRUE) -library(a11ytables) # attach package -``` - -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, run `browseVignettes("a11ytables")` or [visit the package website](https://co-analysis.github.io/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 Analysis Function Central Team released [a Python package called 'gptables'](https://github.com/best-practice-and-impact/gptables) that has [been updated given the latest best-practice guidance](https://dataingovernment.blog.gov.uk/2022/06/24/automatically-produce-best-practice-spreadsheets/). {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](CODE_OF_CONDUCT.html). - -## Copyright and Licensing - -© Crown Copyright, 2022, 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/). diff --git a/README.md b/README.md index a206011..924189f 100644 --- a/README.md +++ b/README.md @@ -1,139 +1,18 @@ - - -# {a11ytables} +# {a11ytables2} - -[![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) +[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) -## Purpose - -An R package to help automatically create reproducible spreadsheets that -adhere to the latest guidance on [releasing statistics in -spreadsheets](https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/) -from the UK government’s [Analysis Function Central -Team](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 intended for 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 - 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.packages("remotes") # if not already installed -remotes::install_github("co-analysis/a11ytables", build_vignettes = TRUE) -library(a11ytables) # attach package -``` - -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()` -2. Pass the output to `generate_workbook()` -3. 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, run -`browseVignettes("a11ytables")` or [visit the package -website](https://co-analysis.github.io/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 Analysis Function Central Team released [a Python package called -‘gptables’](https://github.com/best-practice-and-impact/gptables) that -has [been updated given the latest best-practice -guidance](https://dataingovernment.blog.gov.uk/2022/06/24/automatically-produce-best-practice-spreadsheets/). -{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 +This package is an experimental work-in-progress update of [{a11ytables}](https://co-analysis.github.io/a11ytables/). -Please note that the {a11ytables} project is released with a -[Contributor Code of Conduct](CODE_OF_CONDUCT.html). +Like {a11ytables}, {a11ytables2} is: -## Copyright and Licensing +> An R package to help automatically create reproducible spreadsheets that adhere to the latest guidance on [releasing statistics in spreadsheets](https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/) from the UK government's [Analysis Function Central Team](https://analysisfunction.civilservice.gov.uk/), with a focus on accessibility ('a11y'). -© Crown Copyright, 2022, Cabinet Office +The plan is for {a11ytables2} to: -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/). +* be built on {openxlsx2} instead of {openxlsx} +* take advantage of a 'YAML blueprint' system for specifying a11ytables-class objects +* take advantage of tools like {cli} and {fs} for better messaging and file handling diff --git a/a11ytables.Rproj b/a11ytables2.Rproj similarity index 100% rename from a11ytables.Rproj rename to a11ytables2.Rproj diff --git a/man/a11ytables-package.Rd b/man/a11ytables-package.Rd deleted file mode 100644 index d69b2ad..0000000 --- a/man/a11ytables-package.Rd +++ /dev/null @@ -1,33 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/a11ytables-package.R -\docType{package} -\name{a11ytables-package} -\alias{a11ytables} -\alias{a11ytables-package} -\title{a11ytables: Create Spreadsheet Publications Following Best Practice} -\description{ -\if{html}{\figure{logo.png}{options: align='right' alt='logo' width='120'}} - -Generate spreadsheet publications that follow best practice guidance from the UK government's Analysis Function Central Team, with a focus on accessibility. Based on {openxlsx}. See also the Python package 'gptables'. -} -\seealso{ -Useful links: -\itemize{ - \item \url{https://co-analysis.github.io/a11ytables/} - \item \url{https://github.com/co-analysis/a11ytables} - \item Report bugs at \url{https://github.com/co-analysis/a11ytables/issues} -} - -} -\author{ -\strong{Maintainer}: Matt Dray \email{mwdray@gmail.com} - -Other contributors: -\itemize{ - \item Crown Copyright [copyright holder, funder] - \item Tim Taylor [contributor] - \item Matt Kerlogue [contributor] -} - -} -\keyword{internal} diff --git a/man/a11ytables2-package.Rd b/man/a11ytables2-package.Rd new file mode 100644 index 0000000..2466ac8 --- /dev/null +++ b/man/a11ytables2-package.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/a11ytables2-package.R +\docType{package} +\name{a11ytables2-package} +\alias{a11ytables2} +\alias{a11ytables2-package} +\title{a11ytables2: Create Spreadsheet Publications Following Best Practice} +\description{ +\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} + +Generate spreadsheet publications that follow best practice guidance from the UK government's Analysis Function Central Team, with a focus on accessibility. Based on {openxlsx2}. Successor to 'a11ytables'. See also the Python package 'gptables'. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/matt-dray/a11ytables2} + \item Report bugs at \url{https://github.com/matt-dray/a11ytables2/issues} +} + +} +\author{ +\strong{Maintainer}: Matt Dray \email{mwdray@gmail.com} + +Other contributors: +\itemize{ + \item Crown Copyright [copyright holder, funder] + \item Tim Taylor [contributor] + \item Matt Kerlogue [contributor] +} + +} +\keyword{internal} diff --git a/tests/testthat.R b/tests/testthat.R index bbb7195..f1b329f 100644 --- a/tests/testthat.R +++ b/tests/testthat.R @@ -1,4 +1,4 @@ library(testthat) -library(a11ytables) +library(a11ytables2) -test_check("a11ytables") +test_check("a11ytables2")