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

General refactor #106

Open
matt-dray opened this issue Nov 9, 2023 · 0 comments
Open

General refactor #106

matt-dray opened this issue Nov 9, 2023 · 0 comments
Labels
documentation Improve or add documentation should MoSCoW priority
Milestone

Comments

@matt-dray
Copy link
Collaborator

matt-dray commented Nov 9, 2023

'Simple' changes:

  • Reorganise scripts in R/ for clarity (inc simplify utils)
  • Simplify functions (there probably only needs to be one .get_start_row_*() function with an argument to specify which pre-table information you're trying to insert)
  • Rename suspect variables (table, content?)
  • De-nest where possible (break into intermediate variables)
  • Include more @noRd function docs
  • Sprinkle some more explanatory 'why' comments

Requires more thought/effort:

  • Would it be easier to handle pre-table content if the text of each row were put into a vector? Could then just check the length of that vector and insert the table at length(x) + 1, for example. At the moment there's repetitive checks for 'if blanks message was supplied, then ...', 'if source was supplied, then...'.
  • Drop-in replace {openxlsx2} for {openxlsx} (?) as per Change back-end to use {openxlsx2} #70

Probably more.

@matt-dray matt-dray added documentation Improve or add documentation code labels Nov 9, 2023
@matt-dray matt-dray removed the code label Dec 27, 2023
@matt-dray matt-dray added this to the Backlog milestone May 27, 2024
@matt-dray matt-dray added the should MoSCoW priority label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or add documentation should MoSCoW priority
Projects
None yet
Development

No branches or pull requests

1 participant