search

co-analysis / a11ytables

R package: generate best-practice stats spreadsheets for publication
https://co-analysis.github.io/a11ytables/
Other
42 stars 3 forks source link

Does a contents sheet actually need to be supplied by the user? #75

Closed matt-dray closed 10 months ago

matt-dray commented 2 years ago

Currently the user must add a sheet with sheet_type of "contents". Why? Surely this can be entirely auto-generated; there's nothing extra a user should put in this sheet that isn't already provided (i.e. tab_title and sheet_title).

matt-dray commented 2 years ago

Perhaps because the user may want to add additional information to the table beyond just the tab and sheet titles.

For example, see the Labour Market Overview demo spreadsheet in the best practice guidance, which says:

Note: In this spreadsheet the table of contents includes a column for: publication date, next publication date and source.

This is needed for this spreadsheet as the dates for the next publication date vary and the sources are not all the same.

If all your tables will get updated on the same date and they are all from the same source you can put this information on the cover sheet, you do not need to add these columns to the table of contents.

matt-dray commented 1 year ago

Also it's conceptually easier when using create_a11ytable() to see that you're supplying a number of objects that matches the number of sheets in the output, right? Might seem odd to have one fewer than the user might expect to provide.

matt-dray commented 10 months ago

This is a duplicate of #38.