This is my work for my 4th year dissertation. It builds on the work of a former phd student and my supervisor (https://eprints.gla.ac.uk/280870/). My goal is to build this project in python, as bioinformatics is shifting to using this language over R.
This is a suggested template for a project. You can modify it as you please, but but remember to keep:
- a timelog, updated regularly in the
timelog.mdformat; - all source under version control;
- data well organised and with appropriate ethical approval (for human subject data);
Here's an overview of the structure as it stands:
-
plan.mdA skeleton week-by-week plan for the project. -
data/data you acquire during the project -
src/source code for your project -
status_report/the status report submitted in December -
meetings/Records of the meetings you have during the project. -
dissertation/source and for your project dissertation -
presentation/your presentation -
Make sure you add a
.gitignoreor similar for your VCS for the tools you are using! -
Add any appropriate continuous integration (e.g. Travis CI) in this directory.
-
Remove this
readme.mdfile from any repository and replace it with something more appropriate!
- It should be easy to rebuild and run your project and your dissertation * Include clear instructions in the relevant directories to make this possible