This git repository contains a shell that should be used as the default structure for new projects in the analytical team. It won't fit all circumstances perfectly, and you can make changes and issue a pull request for new features / changes.
The aim of this template is two-fold: firstly to give a common structure for analytical projects to aid reproducibility, secondly to allow for additional security settings as default to prevent accidental upload of files that should not be committed to Git and GitHub.
Please update/replace this README file with one relevant to your project
- Put any data files in the
datafolder. This folder is explicitly named in the .gitignore file. A further layer of security is that all xls, xlsx, csv and pdf files are also explicit ignored in the whole folder as well. _If you need to commit one of these files, you must use the-f(force) command incommit, but you must be sure there is no identifiable data. - Save any documentation in the
docsfile. This does not mean you should avoid commenting your code, but if you have an operating procedure or supporting documents, add them to this folder. - Please save all output: data, formatted tables, graphs etc. in the output folder. This is also implicitly ignored by git, but you can use the
-f(force) command incommitto add any you wish to publish to github.
- Linting your code. This is a formatting process that follows a rule set. We broadly encourage the tidyverse standard, and recommend the
lintrpackage. - Comment your code to make sure others can follow.
- Consider your naming conventions: we recommend
snake casewhere spaces are replaced by underscores and no capitals are use. E.g.outpatient_referral_data
This repository is dual licensed under the Open Government v3 & MIT. All code can outputs are subject to Crown Copyright.