Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

The Turing Way

Read the book Join our tinyletter mailing list Join the chat at https://gitter.im/alan-turing-institute/the-turing-way DOI

All Contributors

Test Status
Netlify build CI
No Latin Phrases Check for Latin Phrases
No Large Files TestFileSizes
No "Lorem Ipsum"s Check for Lorem Ipsums

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

The Turing Way is a lightly opinionated guide to reproducible data science. You can read it here: https://the-turing-way.netlify.com You're currently viewing the project GitHub repository where all of the bits that make up the guide live, and where the process of writing/building the guide happens.

Our goal is to provide all the information that researchers need at the start of their projects to ensure that they are easy to reproduce at the end.

This also means making sure PhD students, postdocs, PIs and funding teams know which parts of the "responsibility of reproducibility" they can affect, and what they should do to nudge data science to being more efficient, effective and understandable.

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

This is (part of) the project team planning work at the Turing Institute. For more on how to contact us, see the ways of working document.

Team photo

Contributing

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

Everyone is asked to follow our code of conduct and to checkout our contributing guidelines for more information on how to get started.

If you are not familiar or confident contributing on GitHub, you can also contribute a case study and your tips and tricks via our Google submission form.

Citing The Turing Way

You can reference The Turing Way through the project's Zenodo archive using DOI: 10.5281/zenodo.3233853. 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:

The Turing Way Community, Becky Arnold, Louise Bowler, Sarah Gibson, Patricia Herterich, Rosie Higman, … Kirstie Whitaker. (2019, March 25). The Turing Way: A Handbook for Reproducible Data Science (Version v0.0.4). Zenodo. http://doi.org/10.5281/zenodo.3233986

You can also share the human-readable URL to a page in the book, for example: https://the-turing-way.netlify.com/reproducibility/03/definitions.html, but be aware that the project is under development and therefore these links may change 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

The Turing Way illustrations are created by artists from Scriberia as part of The Turing Way book dashes in Manchester on 17 May 2019, and London on 28 May 2019 and 21 February 2020. 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://zenodo.org/record/3695300) 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. (2020, March 3). Illustrations from the Turing Way book dashes. Zenodo. http://doi.org/10.5281/zenodo.3695300

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

We have a gitter chat room 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 also have a tiny letter mailing list to which we send monthly project updates. Subscribe at https://tinyletter.com/TuringWay.

You can contact our community manager Malvika Sharan by email at msharan@turing.ac.uk. Alternatively, you can contact the lead investigator Kirstie Whitaker by email at kwhitaker@turing.ac.uk.

Contributors

Thanks goes to these wonderful people (emoji key):


Adina Wagner

🖋

Aditi Shenvi

🤔

Afzal Ansari

🐛

Ago3

🤔

Ahmed Essam

🐛

Aida Mehonic

🤔

Albert Hornos Vidal

👀 🐛

Alex Bird

👀

Alex Chan

🤔

Alex Clarke

📖

Alexander Morley

💬 👀 🤔 ⚠️ 🚇 🚧

Ali Seyhun Saral

📖

Andrea Pierré

🐛

Andrei Alexandru

🐛 👀

Andrew Stewart


Andrian Nobella

🌍

Angelo Varlotta

🌍

Anna Hadjitofi

🖋 🌍

Anna Krystalli

💬 💡 👀 🤔

Annabel Elizabeth Whipp

🤔

Arielle-Bennett

🤔 👀 🖋

Augustinas Sukys

🤔

Barbara Vreede

🖋

Batool

🤔 🖋 🌍 🚇

Becki Green

🤔

Becky Arnold

💬 💻 📖 🤔 👀

Benjamin Mummery

🤔 🖋

Beth Montague-Hellen

📖

Bouwe Andela

🖋

Brandon Lee

🐛

Brigitta Sipőcz

🖋

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

🤔 🖋

Dan Hobley

📖

Danbee Kim

📖

Daniel Lintott

🐛

Daniel Mietchen

🐛

Daniel Nüst

🖋

Danny Garside

🐛

David Foster

👀 🐛

David Stansby

🖋

DerienFe

🤔

Diego Alonso Alvarez

🤔 👀

Dimitra Blana

👀 🖋

Eirini Malliaraki

📖

Eirini Zormpa

🐛 👀

Elizabeth DuPre

🚇 💬 👀

Em K

🖋

Enrico Glerean

🐛

Eric Daub

📖

Eric Leung

🐛

Eric R Scott

🐛

Esther Plomp

🐛 🤔 🖋 👀 📢 📝 🌍

Evelina Gabasova

🐛 🖋

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

🤔

Ian Hinder

📖

IsabelBirds

🤔

Isil Bilgin

🐛

Ismael-KG

🖋 👀 📝 🤔

JKasmire

🐛

Jade Pickering

📖

James Kent

🐛

James Myatt

📖

James Robinson

🤔 💻

Jason Gates

📖 👀

Javier Moldon

📖

Jay Dev Jha

🐛

Jeremy Leipzig

🐛

Jessy Provencher

🌍

Jez Cope

📖

Jill Wang

🐛

Jim Madge

🖋 📖

Joanna Leng

🖋 🤔

Joe Early

🤔

Joe Fennell

📖

Joshua Teves

🤔

José María Fernández

👀

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

🐛

Louise Bowler

💬 💻 📖 💡 🤔 📋 👀

Lovkush

🐛

Luca Bertinetto

🌍

Lupe CaMay

👀

Malvika Sharan

📖 📋 🤔 📆 👀 📢 🚧 📹

Maria Eriksson

🐛

Mariam-ke

🐛

Mark Woodbridge

🤔 🖋

Markus Löning

👀 🖋

Marta-MM

🐛

Martin O'Reilly

💬 🔧 🤔

Martina G. Vilas

🚇 ⚠️ 📢 📹

Mateusz Kuzak

🐛 📋 🤔 👀 🖋

Matthew Evans

🐛

Max Joseph

👀

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

🤔

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

🤔

Pierre Grimaud

🐛

Pooja Gadige

📖

Pranav Mahajan

🖋

Przemek Dolata

🌍

Rachael Ainsworth

📖 📋 🤔 💬 👀 📢

Radka Jersakova

🐛 🖋

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

🤔

Shankho Boron Ghosh

🐛

Sian Bladon

🤔

Siba Smarak Panigrahi

🐛

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

🌍

Tim Head

💬 🤔

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

🤔

Yash Varshney

🐛

Yini

🌍

Yo Yehudi

📖 👀

Yu-Fang Yang

🐛

abrown41

🤔 🖋

acork25

🤔

akira-endo

🤔

alessandroragano

🤔

andreabecsek

🤔

andrealuppi

🤔

ashatitus

👀 🖋

beccawilson

️️️️♿️

benkrikler

🤔 🖋

ceciledebezenac

🤔

daniguariso

🤔

giuliaok

🤔

glumand

🌍

irenekp

🖋

kgrieman

🤔

l-gorman

🤔

leavanh

🐛

mjcasy

🤔 🖋

msanter01

🌍 📢

oxpeter

🐛

peterrhysstrong

🤔

rabbits99

🌍

sallyob123

🤔

sethsh7

🤔

sliaqat3

👀

smasarone

🤔

swalkoAI

🤔

takuover

🤔

tugceoruc

🤔

vasilisstav

🤔

yaseminturkyilmaz

📝 🤔

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