Main Script Files
A list of files needed to run the code - this can be reduced to just the main file if it is organised in such a way that related files are referenced clearly through comments or loaded in the main script themselves
Author(s):
Release Date:
Review by:
Version:
Language(s):
Code Style Followed:
Information about the project goes in here. This should be a brief description of it’s purpose and what it does.
You may want to link or mention additional material in here such as user guides, flowcharts etc..
This should include the version of the main programme (e.g R/Python/Stata)
This should also include add-ons, libraries or packages
Any needed disclaimers - this may be for the code, for new outputs created etc.
If any instructions are needed to install packages - they should be here.
A list of files needed to run the code - this can be reduced to just the main file if it is organised in such a way that related files are referenced clearly through comments or loaded in the main script themselves
Data Sets available within the SRS and data sets that are ingested for this project should be listed here.
Links to data sets should be removed from the code or handled using “secrets”/unpublished settings files. This is to ensure data access only to those authorised to use it.
Sometimes there are elements that can’t be shared widely; information about these should be listed here with details of how the user can access them. Note that including elements that require very specific permissions may discourage someone from using your code.
A declaration to indicate
Declaration that the code produced is the responsibility of the producing team. !HHW wording to be confirmed here
Optional - contact information for the team.
Contact us on - example@example.com