Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reset repo, docs for a11ytables2 #96

Merged
merged 1 commit into from
Sep 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
^a11ytables\.Rproj$
^a11ytables2\.Rproj$
^\.Rproj\.user$
^data-raw$
^README\.Rmd$
Expand Down
53 changes: 49 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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"),
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2022
COPYRIGHT HOLDER: 2022 Crown Copyright (Cabinet Office)
YEAR: 2023
COPYRIGHT HOLDER: 2023 Crown Copyright (Cabinet Office)
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
131 changes: 2 additions & 129 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
86 changes: 0 additions & 86 deletions README.Rmd

This file was deleted.

Loading
Loading