Initial workplan

[chrismainey]

Hi Everyone,
This post is to lay out an initial work programme as we start to build the package. We discussed this with Neil, Yasser, Tom, Zoë, me (Chris), and Mohammed. Feel free to edit/alter. These could be translated into Issues. I'll let those who know GitHub better advise us
Work is roughly in the following areas:

Set-up

• Set up repository
• Set up R package structures
• Translate Neil's existing aggregate functions into package format
• Fill in appropriate metadata for each function
• Build unit tests
• Set up code coverage
• Set up GitHub actions to run tests
• Test

Use-case

• Write examples of using the aggregate functions
• Build examples including preparing the data for input
• Test

Data preparation and mechanics

• Assess and build appropriate helper functions for shaping and preparing data, informed by work on examples
• Write input data specification
• Create demo dataset to be bundled with package
• Test by having NHS-R community apply it to their local data

Communication

• Assess what communication we want to do and how.
• Make videos / present webinars / talks etc.
• Build package-down website on GitHub

Visualisation

• Use Yasser's prior work to build similar visualisations in R
• Add additional tools like Sankey Diagrams where we have a use case

Further elements

• Build Rmarkdown / Quarto reporting output
• Shiny app that allows upload of data to prepare report?
• Consider longer-term forecasting mechanism

[ThomUK]

@matt-dray raised the proposal to add an item for writing input checks within the functions, to guard against type problems and support testing. Thanks Matt - please do go ahead and raise an issue for that...