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
818 Stars 282 Forks Other 6.8K Commits 385 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

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

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

| 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

: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 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. That room is also synchronised with Matrix at #the-turing-way:matrix.org and you're welcome to join us there if you prefer.

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 [email protected]. Alternatively, you can contact the lead investigator Kirstie Whitaker by email at [email protected].

Contributors

Thanks goes to these wonderful people (emoji key):


Adina Wagner

πŸ–‹

Aditi Shenvi

πŸ€”

Ahmed Essam

πŸ›

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-Lovell

πŸ€” πŸ‘€

Augustinas Sukys

πŸ€”

Barbara Vreede

πŸ–‹

Batool

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

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

πŸ€”

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

πŸ“–

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

πŸ“–

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

πŸ‘€

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

πŸ€”

Robin Long

πŸ“–

Rohit Midha

πŸ“–

Romero Silva

🌍

Rose Sisk

πŸ€”

Rosie Higman

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

Rosti Readioff

πŸ“–

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

πŸ›

Wiebke Toussaint

πŸ›

Will Hulme

πŸ“–

Wolmar Nyberg Γ…kerstrΓΆm

πŸ‘€

Xiaoqing Chen

πŸ€”

Yash Varshney

πŸ›

Yini

🌍

Yo Yehudi

πŸ“– πŸ‘€

Yu-Fang Yang

πŸ›

acork25

πŸ€”

akira-endo

πŸ€”

alessandroragano

πŸ€”

ashatitus

πŸ‘€

beccawilson

️️️️♿️

ceciledebezenac

πŸ€”

daniguariso

πŸ€”

giuliaok

πŸ€”

glumand

🌍

irenekp

πŸ–‹

kgrieman

πŸ€”

l-gorman

πŸ€”

leavanh

πŸ›

mjcasy

πŸ€” πŸ–‹

msanter01

🌍 πŸ“’

oxpeter

πŸ›

rabbits99

🌍

sallyob123

πŸ€”

sethsh7

πŸ€”

sliaqat3

πŸ‘€

smasarone

πŸ€”

swalkoAI

πŸ€”

takuover

πŸ€”

tugceoruc

πŸ€”

vasilisstav

πŸ€”

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.