Template for setting up reproducible projects

This is a template for setting up a research or data science project online, such as on GitHub.

About this Repository

This repository operationalises The Turing Way recommendations for structuring project repositories to support reproducibility in data science projects. This repository includes files and directories recommended for enabling reproducibility and collaboration in a project, as well as sharing of research objects.

This repository follows the recommendations and guidance provided in The Turing Way handbook to data science. When reusing this repository, please update the information on your README page with information about your project.

Using this Repository

Image Description:

Your streamlined project setup is just three steps away:

Step 1: Click 'Use this template' on the top right-hand side. Follow it up by clicking 'Create a new repository.'
Step 2: In the subsequent window, set the 'owner' (yourself or a GitHub organisation) and give your project repository a descriptive name.
Step 3: Finalise by clicking 'Create repository' at the bottom right-hand side.

After creating your own copy of this repository, you can edit or delete existing files and folders, or add new ones as per your needs.

About README

On an online repository, such as GitHub, the project overview page is named ‘README’ which is equivalent to the main page of a website. README page should describe the project -- what is the purpose of the project, who is involved, how to collaborate and where to find key resources.

To learn more about how to create a README.md file, please read the Landing Page - README File chapter in The Turing Way Guide for Project Design.

When reusing, you can delete most content written here, and use this MarkDown template to add content about your project:

# Project Quick Start

*Add Badges/GitHub shields, which are clickable buttons that provide concise actions related to the project.*

*A sentence summarising what to expect from this repository*  

## Vision and Mission

- **Vision:** One sentence capturing the project's overarching vision.
- **Mission:** One sentence defining the project's goals and target audience.

## About

Motivation and background in a nutshell.

## Roadmap & Milestones

- **Goals:** Clear overview of overarching and short-term goals.
- **Outcomes:** Description of expected results and deliverables.

## The Team

- **Members:** List of team members.
- **Roles & Collaboration:** [Team Directory](link-to-directory) outlines roles, responsibilities, and collaboration opportunities.

## Contributing

- **Guidelines:** [Contribution Guidelines](link-to-guidelines) for contributors.
- **Code of Conduct:** [Code of Conduct](link-to-coc) ensures a respectful project environment.
- **Resource Plans:** Details on available resources and recommended practices for the project team.

## Citing & Acknowledgement

- **Citation Instructions:** How to cite the project.
- **Acknowledgment:** Recognising contributions by different members.

## Contact

- **Reach Out:** Contact details for questions, feedback, or ideas.

Repo Structure

Inspired by Cookie Cutter Data Science.

├── LICENSE
├── README.md          <- The top-level README for users of this project.
├── CODE_OF_CONDUCT.md <- Guidelines for users and contributors of the project.
├── CONTRIBUTING.md    <- Information on how to contribute to the project.
├── data
│   ├── processed      <- The final, canonical data sets for modeling.
│   └── raw            <- The original, immutable data dump.
│
├── docs               <- A default Sphinx project; see sphinx-doc.org for details
│
├── models             <- Trained and serialized models, model predictions, or model summaries
│
├── notebooks          <- Jupyter notebooks. The naming convention is a number (for ordering),
│                         the creator's initials, and a short `-` delimited description, e.g.
│                         `1.0-jqp-initial-data-exploration`.
│
├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures        <- Generated graphics and figures to be used in reporting
│
├── project_management <- Meeting notes and other project planning resources
│
├── src                <- Source code for use in this project.
│   │
│   ├── data           <- Scripts to download or generate data
│   │   └── make_dataset.py
│   │
│   ├── models         <- Scripts to train models and then use trained models to make
│   │   │                 predictions
│   │   ├── predict_model.py
│   │   └── train_model.py
│   │
│   └── visualisation  <- Scripts to create exploratory and results-oriented visualisations
│       └── visualise.py
└──

Maintainers

This repository has been set up and maintained by Malvika Sharan to support the work of Open Research Community Management and Research Application Management teams under the Tools, Practices and Systems Research Programme at The Alan Turing Institute.

As an open source repository, anyone beyond these teams is very welcome to reuse this template for setting up their projects.

Please create an issue to share references or ideas related to the development of this project.

🎯 Roadmap

Checklist for setting an online repository

📫 Contact

For any organisation-related queries or concerns, you can directly reach out to Malvika Sharan by emailing msharan@turing.ac.uk.

♻️ License

This work is licensed under the MIT license (code) and Creative Commons Attribution 4.0 International license (for documentation). You are free to share and adapt the material for any purpose, even commercially, as long as you provide attribution (give appropriate credit, provide a link to the license, and indicate if changes were made) in any reasonable manner, but not in any way that suggests the licensor endorses you or your use and with no additional restrictions.

🤝 Acknowledgement

This repository has been created for anyone to reuse -- please attribute us as:

This repository uses the template created and maintained by The Turing Way team members and shared under CC-BY 4.0 for reuse: https://github.com/alan-turing-institute/reproducible-project-template.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Malvika Sharan}
🤔 🖋

_{Emma Karoune}
🤔 📖

_{Anne Lee Steele}
🤔 📖

_{Vicky Hellon}
🤔 📖

_{Jennifer Ding}
🖋 📖 🤔

_{Hilmar Lapp}
🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Template repository for setting a reproducible research project.

Other