){kind=logo}
This README.md file in also available in Chinese (README-Chinese), Dutch (README-Dutch), French (README-French.md), German (README-German.md), Indonesian (README-Indonesian), Italian (README-Italian), Korean (README-Korean), Portuguese (README-Portuguese), and Spanish (README-Spanish) (listed alphabetically).
Total Contributors:
| Information | Links |
|---|---|
| Project |   |
| News |     |
| Chat with us in Slack |  |
| Discuss on GitHub |   |
| Build |     |
| Cite |  |
Welcome to The Turing Way project GitHub repository. This is where all the components of the project are developed, reviewed and maintained.
The Turing Way is a handbook to reproducible, ethical and collaborative data science. We involve and support a diverse community of contributors to make data science accessible, comprehensible and effective for everyone. Our goal is to provide all the information that researchers and data scientists in academia, industry and the public sector need at the start of their projects to ensure that they are easy to reproduce at the end.
The Turing Way is a book, a community and a global collaboration.
All stakeholders, including students, researchers, software engineers, project leaders and funding teams, are encouraged to use The Turing Way to understand their roles and responsibility of reproducibility in data science. You can read the book online, contribute to the project as described in our contribution guidelines and re-use all materials (see the License). We also invite you to contribute to the translation of The Turing Way into different languages and help make research reproducibility accessible to a wider global audience. If you are interested in contributing, please refer to the guidelines provided in the book's handbook and join our collaborative efforts.
Screenshot of The Turing Way online book (use this image in a presentation)
Started in 2019 as a lightly opinionated guide to data science, The Turing Way has since expanded into a series of guides on Reproducible Research, Project Design, Communication, Collaboration and Ethical Research. Each guide offers chapters on a range of topics covering best practices, guidance and recommendations. These chapters have been co-authored by contributors who are students, researchers, educators, community leaders, policy-makers and professionals from diverse backgrounds, lived experiences and domain knowledge.
Our moonshot goal is to make reproducibility "too easy not to do".
Table of Contents:
π§ If you prefer an audio introduction to the project, our team member Rachael presented at the Open Science Fair 2019 in Porto and her demo was recorded by the Orion podcast. The Turing Way overview starts at minute 5:13.
Reproducible research is necessary to ensure that scientific work can be trusted. Funders and publishers are beginning to require that publications include access to the underlying data and the analysis code. The goal is to ensure that all results can be independently verified and built upon in future work. This is sometimes easier said than done. Sharing these research outputs means understanding data management, library sciences, software development, and continuous integration techniques: skills that are not widely taught or expected of academic researchers and data scientists. As these activities are not commonly taught, we recognise that the burden of requirement and new skill acquisition can be intimidating to individuals who are new to this world. The Turing Way is a handbook to support students, their supervisors, funders and journal editors in ensuring that reproducible data science is "too easy not to do" even for people who have never worked in this way before. It will include training material on version control, analysis testing, and open and transparent communication with future users, and build on Turing Institute case studies and workshops. This project is openly developed and any and all questions, comments and recommendations are welcome at our GitHub repository: https://github.com/alan-turing-institute/the-turing-way.
The Turing Way is an open collaboration and community-driven project. Everyone who contributes to this book, no matter how small or big their contributions are, is recognised in this project as a contributor and a community member. Long-term contributors of the project are considered part of the core contributors groups who take on various leadership roles in the project, as described in the Ways of Working document.
The project is coordinated by the co-lead investigators Kirstie Whitaker (founder) and Malvika Sharan, and hosted at The Alan Turing Institute. Anne Lee Steele is the Community Manager of The Turing Way since March 2022 and Alexandra Araujo Alvarez is the Research Project Manager since February 2023.
You can read The Turing Way acknowledgement process and Record of Contributions to learn about how we acknowledge your work and how our contributors are highlighted in the project. Please see the Contributors Table for the GitHub profiles of all our contributors.
π§ This repository is always a work in progress and everyone is encouraged to help us build something that is useful to the many. π§
Everyone who joins the project is expected to follow our code of conduct and to check out our contributing guidelines for more information on how to get started. We want to meet our contributors where they are. Therefore, we provide multiple entry points for you to contribute based on your interest, availability or skill requirements.
Contributions include development and sharing of new chapters; maintenance and improvement of existing chapters; sharing The Turing Way resources; review and updating of previously developed materials; translating its chapter to help make this project globally accessible, and sharing best practices in research.
Community members are provided with opportunities to learn new skills, share their ideas and collaborate with others. They are also given mentorship opportunities in the project as they make their contributions to The Turing Way or other open source projects and are encouraged to mentor new participants of the project.
We have created a promotion pack to help you in presenting and sharing about The Turing Way in your network.
We release the latest version of The Turing Way through the project's Zenodo archive using DOI: 10.5281/zenodo.3233853. This DOI is a "concept DOI" which means it will always resolve to the latest version. If you need to cite a specific version you can find those DOIs at the zenodo page above. DOIs allow us to archive the repository and they are really valuable to ensure that the work is tracked in academic publications.
The citation will look something like this:
The Turing Way Community. (2021, November 10). The Turing Way: A handbook for reproducible, ethical and collaborative research. Zenodo. http://doi.org/10.5281/zenodo.3233853
To see our workflow for making releases for different versions and to suggest improvements, please head over to the release workflow document.
You can share the human-readable URL to a page in the book, for example, https://the-turing-way.netlify.app/reproducible-research/overview/overview-definitions.html, but be aware that the project is under development and therefore these links may update over time. You might want to include a web archive link such as https://web.archive.org/web/20191030093753/https://the-turing-way.netlify.com/reproducibility/03/definitions.html to make sure that you don't end up with broken links everywhere!
We really appreciate any references that you make to The Turing Way project in your and we hope it is useful. If you have any questions please get in touch.
The Turing Way illustrations are created by artists from Scriberia as part of The Turing Way book dashes in Manchester on 17 May 2019, London on 28 May 2019 and 21 February 2020, and online on 27th November 2020 and 28th May 2021. They depict a variety of content from the handbook, collaborative efforts in the community and The Turing Way project in general. These illustrations are available on Zenodo (https://doi.org/10.5281/zenodo.3332807) under a CC-BY license.
When using any of the images, please include the following attribution:
This image was created by Scriberia for The Turing Way community and is used under a CC-BY licence.
The latest version from Zenodo can be cited as:
The Turing Way Community, & Scriberia. (2021, May 29). Illustrations from the Turing Way book dashes. Zenodo. https://doi.org/10.5281/zenodo.4906004
We have used a few of these illustrations in the Welcome Bot's responses to new members' contributions in this GitHub repository.
You can contact The Turing Way team by emailing [email protected] or [email protected].
You can also contact Anne Lee Steele ([email protected]), Malvika Sharan ([email protected]), Alexandra Araujo Alvarez ([email protected]) or Kirstie Whitaker ([email protected]).
Connect with others and discuss your ideas on Slack using this invitation link.
We also have a Gitter chat room (if you prefer an open source alternative for chat) and we'd love for you to swing by to say hello at https://gitter.im/alan-turing-institute/the-turing-way. The room is also accessible with a Matrix account at #alan-turing-institute_the-turing-way:gitter.im.
We have a tinyletter mailing list to which we send monthly project updates. Subscribe at https://tinyletter.com/TuringWay.
You can also follow us on Twitter (@turingway) and Mastodon.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!