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

Choose better function and argument names #27

Closed matt-dray closed 2 years ago

matt-dray commented 2 years ago

Need to be more descriptive and helpful to the user. These will be breaking. Suggest changing them for v0.1.0.

Functions

Arguments

matt-dray commented 2 years ago

create_a11ytable() and generate_workbook() are probably the right choices. Start with verbs. 'Create' implies building from scratch. 'Generate' implies the workbook is being created from some kind of input (i.e. an a11ytable). I like the idea of 'convert' as a verb, but I don't like the three words inconvert_to_workbook(), while convert_workbook() is ambiguous (converting from a workbook or to a workbook?).

matt-dray commented 2 years ago

Provide a deprecation warning to new_a11ytable() and create_a11y_wb()?