Need help with the-turing-way?
Click the β€œchat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

alan-turing-institute
1.1K Stars 435 Forks Other 8.9K Commits 433 Opened issues

Description

Host repository for The Turing Way: a how to guide for reproducible data science

Services available

!
?

Need anything else?

Contributors list

The Turing Way

This README.md file in also available in 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:

All Contributors <!-- ALL-CONTRIBUTORS-BADGE:END -->

| Information | Links | | :--- | :--- | | Project | Read the book | | News | Twitter Follow Join our tinyletter mailing list YouTube Channel Views | | Chat | Join Slack GitHub issues GitHub pull requests | | Build | Netlify build Latin Phrases TestFileSizes Check for Lorem Ipsums | | Cite | Cite this using DOI |

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 project is a book, community, an open-source project and a culture of collaboration. This is shown in four illustrations, the first one showing the Turing Way book, the second showing how the community can grow, the third one showing two people collaborating on a pull request, the last one is showing a balance where reproducibility is valued more than the number of papers published.

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).

This is a screenshot of the online Turing Way book. It also shows one of the Turing Way illustrations at the beginning of the book. In this illustration, there is a road or path with shops for different data science skills. People can go in and out with their shopping cart and pick and choose what they need.

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.

About the Project

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 Team

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.

The project is coordinated by the lead investigators Kirstie Whitaker (founder) and Malvika Sharan (community developer) and hosted at The Alan Turing Institute.

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.

Contributing

:construction: This repository is always a work in progress and everyone is encouraged to help us build something that is useful to the many. :construction:

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.

This image shows six of many kinds of contributions that anyone can make. These are: Develop and share, Maintain and improve, Share resources, Review and update, Make it global through translation, and Share best practices

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.

Citing The Turing Way

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.

Citing The Turing Way Illustrations

This is an example of one of The Turing Way illustrations. It tries to shows the evolution towards an open science era

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.

Get in Touch

Email

You can contact The Turing Way team by emailing [email protected].

You can also contact Malvika Sharan by emailing [email protected] or Kirstie Whitaker by emailing [email protected].

Chat

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.

Recieve Updates

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).

Contributors

Thanks goes to these wonderful people (emoji key):


Aakash Raj

🌍

Achintya Rao

πŸ› πŸ‘€

Adina Wagner

πŸ–‹

Aditi Shenvi

πŸ€”

Afzal Ansari

πŸ›

Ago3

πŸ€”

Ahmed Essam

πŸ›

Aida Mehonic

πŸ€”

Albert Hornos Vidal

πŸ‘€ πŸ›

Alden Conner

πŸ›

Alejandro Β©

πŸ–‹ πŸ€”

Alex Bird

βœ… πŸ‘€

Alex Chan

πŸ€”

Alex Clarke

πŸ“–

Alexander Morley

πŸ’¬ πŸ‘€ πŸ€” ⚠️ πŸš‡ 🚧

Ali Seyhun Saral

πŸ“–

Ali Seyhun Saral

πŸ‘€

Andrea PierrΓ©

πŸ›

Andrea SΓ‘nchez-Tapia (she/her)

πŸ–‹ πŸ€”

Andreea Avramescu

πŸ–‹

Andrei Alexandru

πŸ› πŸ‘€

Andrew Stewart

βœ…

Andrian Nobella

🌍

Angelo Varlotta

🌍

Aniketh Varma

πŸ›

Anna Hadjitofi

πŸ–‹ 🌍 βœ…

Anna Krystalli

πŸ’¬ πŸ’‘ πŸ‘€ πŸ€” βœ…

Annabel Elizabeth Whipp

πŸ€”

Arielle-Bennett

πŸ€” πŸ‘€ πŸ–‹

Aryan nath

πŸ›

Augustinas Sukys

πŸ€”

Barbara Vreede

πŸ–‹

Batool

πŸ€” πŸ–‹ 🌍 πŸš‡ πŸ‘€

Becki Green

πŸ€” πŸ–‹

Becky Arnold

πŸ’¬ πŸ’» πŸ“– πŸ€” πŸ‘€

Benjamin Mummery

πŸ€” πŸ–‹

Beth Montague-Hellen

πŸ“–

Bouwe Andela

πŸ–‹

Brandon Lee

πŸ›

Brigitta SipΕ‘cz

πŸ–‹

Bruno Camino

πŸ–‹

Callum Mole

πŸ€”

Cameron Trotter

πŸ€”

Camila Rangel Smith

πŸ“– 🌍 🚧

Carlos Martinez

πŸ› πŸ‘€ πŸ–‹

Carlos Vladimiro GonzΓ‘lez Zelaya

πŸ€”

Cassandra Gould van Praag

πŸ€” πŸ“–

Cem Ulus

🌍

Chad Gilbert

πŸ›

Chandler Klein

πŸ›

Chanuki Illushka Seresinhe

πŸ“–

Charlotte Watson

πŸ€”

Chris Holdgraf

πŸ’¬ πŸ€”

Chris Markiewicz

πŸ€”

Chris Tomlinson

πŸ€”

Christina Hitrova

πŸ€”

Christopher Lovell

πŸš‡

Clare Liggins

πŸ“–

Colin Sauze

πŸ€” πŸ–‹

Collin Schwantes

πŸ›

DaisyParry

πŸ–‹

Dan Hobley

πŸ“–

Danbee Kim

πŸ“–

Daniel Lintott

πŸ›

Daniel Mietchen

πŸ›

Daniel NΓΌst

πŸ–‹

Danny Garside

πŸ› πŸ–‹ πŸ‘€

David Foster

πŸ‘€ πŸ›

David Stansby

πŸ–‹

DerienFe

πŸ€”

Diego Alonso Alvarez

πŸ€” πŸ‘€

Dimitra Blana

πŸ‘€ πŸ–‹

Dinesh kumar

πŸ›

Eirini Malliaraki

πŸ“–

Eirini Zormpa

πŸ› πŸ‘€

Elizabeth DuPre

πŸš‡ πŸ’¬ πŸ‘€

Em K

πŸ–‹ πŸ› πŸ“ πŸ‘€ πŸ“’

Enrico Glerean

πŸ›

Eric Daub

πŸ“–

Eric Leung

πŸ›

Eric R Scott

πŸ›

Esther Plomp

πŸ› πŸ€” πŸ–‹ πŸ‘€ πŸ“’ πŸ“ 🌍

Evelina Gabasova

πŸ› πŸ–‹

Faruk D.

πŸ–‹

Federico Nanni

πŸ› πŸ–‹ πŸ‘€

Ferran Gonzalez Hernandez

πŸ€”

Florian Gilcher

πŸ›

Frances Cooper

πŸ–‹ πŸ€”

Frances Madden

πŸ–‹

Fuad Reza Pahlevi

🌍

Georgia

πŸ€”

Georgia Atkinson

πŸ€”

Georgia Tomova

πŸ€”

Georgiana Elena

πŸ‘€

Gertjan van den Burg

πŸ“– πŸ€” πŸ’¬

Gianni Scolaro

πŸ›

Graham Lee

πŸ› πŸ‘€

Greg Kiar

πŸ“– πŸ‘€

Gustavo Becelli do Nacimento

🌍

Heidi Seibold

πŸ€” πŸ–‹

Hieu Hoang

πŸ€”

Iain

πŸ‘€

Ian Hinder

πŸ“–

IsabelBirds

πŸ€”

Isil Bilgin

πŸ›

Ismael-KG

πŸ–‹ πŸ‘€ πŸ“ πŸ€”

JKasmire

πŸ›

Jade Pickering

πŸ“–

James Kent

πŸ›

James Myatt

πŸ“–

James Robinson

πŸ€” πŸ’»

James Thomas

πŸ›

Jason Gates

πŸ“– πŸ‘€

Javier Moldon

πŸ“–

Jay Dev Jha

πŸ›

Jennifer Ding

πŸ›

Jeremy Crampton

πŸ›

Jeremy Leipzig

πŸ›

Jessica

πŸ–‹

Jessy Provencher

🌍

Jez Cope

πŸ“–

Jill Wang

πŸ›

Jim Madge

πŸ–‹ πŸ“–

Joanna Leng

πŸ–‹ πŸ€”

Joe Early

πŸ€”

Joe Fennell

πŸ“–

Joshua Teves

πŸ€”

JosΓ© MarΓ­a FernΓ‘ndez

πŸ‘€

Julia Guiomar Niso GalΓ‘n

🌍 πŸ‘€

Julien Colomb

πŸ–‹

Katherine Dixey

πŸ€”

Kelly-dot

πŸ€”

Kesson Magid

πŸ€”

Kevin Kunzmann

πŸ“– πŸ€” πŸ›

Kim De Ruyck

πŸ›

Kim De Ruyck

πŸ–‹

Kirstie Whitaker

πŸ’¬ πŸ“– 🎨 πŸ“‹ πŸ” πŸ€” πŸ‘€ πŸ“’

Kristijan Armeni

πŸ›

Krunal Rank

πŸ›

Lachlan Mason

πŸ€” πŸ“– πŸ’»

Laura Acion

️️️️♿️ 🌍 πŸ–‹

Laura Carter

πŸ‘€ πŸ› πŸ€” πŸ–‹

Lenka

πŸ“ πŸ–‹

Liberty Hamilton

πŸ›

Lion-admin

πŸ›

Louise Bowler

πŸ’¬ πŸ’» πŸ“– πŸ’‘ πŸ€” πŸ“‹ πŸ‘€

Lovkush

πŸ›

Luca Bertinetto

🌍

Luigi Scalzone

🌍

Luna

🌍

Lupe CaMay

πŸ‘€

Malvika Sharan

πŸ“– πŸ“‹ πŸ€” πŸ“† πŸ‘€ πŸ“’ 🚧 πŸ“Ή

Marcos Ellys Rocha Honorato

🌍 πŸ‘€

Maria Eriksson

πŸ›

Mariam-ke

πŸ›

Mariana V.

πŸ› πŸ–‹

Mariona

πŸ–‹

Mark Woodbridge

πŸ€” πŸ–‹

Markus LΓΆning

πŸ‘€ πŸ–‹

Marta-MM

πŸ› πŸ–‹

Martin O'Reilly

πŸ’¬ πŸ”§ πŸ€”

Martina G. Vilas

πŸš‡ ⚠️ πŸ“’ πŸ“Ή βœ…

Mateusz Kuzak

πŸ› πŸ“‹ πŸ€” πŸ‘€ πŸ–‹

Matthew Evans

πŸ›

Max Joseph

πŸ‘€

Melissa Black

πŸ‘€ πŸ–‹

Michael Grayling

πŸ“–

Miguel Rivera

πŸ›

Mustafa Anil Tuncel

πŸ›

Nadia Soliman

πŸ“–

Naomi Penfold

πŸ‘€ πŸ€”

Natacha Chenevoy

πŸ€”

Natalie Thurlby

πŸ’» ⚠️

Nathan Begbie

πŸ› πŸ€”

Neha Moopen

πŸ‘€ πŸ–‹

Neil Chue Hong

πŸ€”

Nick Barlow

πŸ› πŸ–‹

Nico

πŸ€”

NicolΓ‘s Alessandroni

πŸ€”

Nina

πŸ‘€

Nomi Harris

πŸ‘€

NotActuallyACat

πŸ€”

Obi Thompson Sargoni

πŸ€”

Oliver Clark

πŸ“–

Oliver Forrest

πŸ“– πŸ€” πŸ–‹ πŸ‘€

Oliver Hamelijnck

πŸ€”

Oliver Strickson

πŸ’¬ πŸ“– βœ…

Oscar Giles

πŸ“–

Pablo RodrΓ­guez-SΓ‘nchez

πŸ–‹

Patricia Herterich

πŸ’¬ πŸ“– πŸ‘€ πŸ€” πŸ–‹

Paul Dominick Baniqued

πŸ€”

Paul Owoicho

πŸ€” πŸ‘€ πŸ› πŸ“–

Paula Andrea Martinez

πŸ€” πŸ‘€

Pedro Pinto da Silva

πŸ€”

PeterC-ATI

πŸ€”

Philip Darke

πŸ€”

Phillip Crout

πŸ›

Pierre Grimaud

πŸ›

Pooja Gadige

πŸ“– πŸ‘€

Pranav Mahajan

πŸ–‹

Przemek Dolata

🌍

Rachael Ainsworth

πŸ“– πŸ“‹ πŸ€” πŸ’¬ πŸ‘€ πŸ“’

Radka Jersakova

πŸ› πŸ–‹

Rafaela Queiroz

🌍

Rahul Thakare

🌍

Raniere Silva

πŸ–‹

Reina Camacho Toro

🌍

Remi Gau

πŸ› πŸ–‹

Reshama Shaikh

πŸ› πŸ–‹

Richard Gilham

πŸ“– πŸ€”

Risa Ueno

πŸ€”

Robert Precious

️️️️♿️

Robin Long

πŸ“–

Rohit Midha

πŸ“–

Romero Silva

🌍

Rose Sisk

πŸ€”

Rosie Higman

πŸ’¬ πŸ“‹ πŸ‘€ πŸ€”

Rosti Readioff

πŸ“–

SYU-NING

πŸ€”

Samuel Guay

🌍

Samuel Nastase

πŸ›

Sangram K Sahu

πŸ€”

Sarah Gibson

πŸ’¬ πŸ’» πŸ“– πŸ”§ πŸ‘€ πŸ“’ πŸ€” βœ… πŸ“Ή

Sarah Stewart

πŸ“– πŸ€”

SarahAlidoost

πŸ–‹

Sedar Olmez

πŸ€”

Sergi

🌍 πŸ‘€

Shankho Boron Ghosh

πŸ›

Sian Bladon

πŸ€”

Siba Smarak Panigrahi

πŸ›

Simon Christ

πŸ›

Solon

πŸ€”

Sophia Batchelor

πŸ‘€ πŸ€” 🚧 πŸ“’

Sparkler

🌍

Srishti Nema

πŸ› πŸ–‹

Stefan Janssen

🌍

Stefan Verhoeven

πŸ–‹

Stephan Druskat

πŸ“– πŸ–‹ πŸ€”

Stephen Eglen

πŸ‘€

Sumera Priyadarsini

πŸ›

Susanna-Assunta Sansone

πŸ“–

Tania Allard

πŸ€” πŸ’¬

Tarek Allam

πŸš‡ πŸ“–

Tess Gough

πŸ€”

Thomas Sandmann

🌍

Thya van den Berg

πŸ“‹

Tim Head

πŸ’¬ πŸ€”

Tim Myers

πŸ›

Tim Powell

πŸ€” πŸ–‹

Tony Yang

πŸ“– 🌍 πŸš‡

Tushar Rohilla

πŸ› πŸ–‹

Veronika Cheplygina

πŸ€” πŸ–‹

Victoria

πŸ€”

Victoria Dominguez del Angel

πŸ›

Warrick Ball

πŸ€” πŸ–‹

Wiebke Toussaint

πŸ›

Will Hulme

πŸ“–

Wolmar Nyberg Γ…kerstrΓΆm

πŸ‘€

Xiaoqing Chen

πŸ€”

Yanina Bellini Saibene

πŸ–‹ 🌍 πŸ‘€

Yash Varshney

πŸ›

Yini

🌍

Yo Yehudi

πŸ“– πŸ‘€

Yu-Fang Yang

πŸ›

ZoeIngr

πŸ–‹

abrown41

πŸ€” πŸ–‹

acork25

πŸ€”

akira-endo

πŸ€”

alessandroragano

πŸ€”

alihumayun

πŸ› πŸ‘€

andreabecsek

πŸ€”

andrealuppi

πŸ€”

ashatitus

πŸ‘€ πŸ–‹

beccawilson

️️️️♿️

benkrikler

πŸ€” πŸ–‹

ceciledebezenac

πŸ€”

claudia-belardi

πŸ‘€

daniguariso

πŸ€”

giuliaok

πŸ€”

glumand

🌍

griff-rees

πŸ›

hlnicholls

πŸ–‹

irenekp

πŸ–‹

kgrieman

πŸ€”

l-gorman

πŸ€”

leavanh

πŸ›

lottycoupat

πŸ› πŸ–‹

mcnanton

πŸ› πŸ–‹

mishkanemes

πŸ“‹

mjcasy

πŸ€” πŸ–‹

msanter01

🌍 πŸ“’

oxpeter

πŸ›

peterrhysstrong

πŸ€”

rabbits99

🌍

raptorchief

πŸ›

sallyob123

πŸ€”

sethsh7

πŸ€”

sliaqat3

πŸ‘€

smasarone

πŸ€”

swalkoAI

πŸ€”

takuover

πŸ€”

tugceoruc

πŸ€”

vasilisstav

πŸ€”

vcpope

πŸ“’

vhellon

πŸ‘€ πŸ–‹

yaseminturkyilmaz

πŸ“ πŸ€”

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.