the-turing-way

by alan-turing-institute

alan-turing-institute /the-turing-way

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

618 Stars 202 Forks Last release: over 1 year ago (v0.0.4) Other 5.1K Commits 4 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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-BADGE:START - Do not remove or modify this section --> 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 |

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


Rachael Ainsworth

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

Tarek Allam

πŸš‡ πŸ“–

Tania Allard

πŸ€” πŸ’¬

Diego Alonso Alvarez

πŸ€” πŸ‘€

Bouwe Andela

πŸ–‹

Kristijan Armeni

πŸ›

Becky Arnold

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

Dimitra Blana

πŸ‘€ πŸ–‹

Louise Bowler

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

Alex Clarke

πŸ“–

Jez Cope

πŸ“–

Eric Daub

πŸ“–

Stephan Druskat

πŸ“– πŸ–‹

Elizabeth DuPre

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

Stephen Eglen

πŸ‘€

Joe Fennell

πŸ“–

Oliver Forrest

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

Pooja Gadige

πŸ“–

Jason Gates

πŸ“– πŸ‘€

Sarah Gibson

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

Oscar Giles

πŸ“–

Richard Gilham

πŸ“– πŸ€”

Cassandra Gould van Praag

πŸ€” πŸ“–

Michael Grayling

πŸ“–

Nomi Harris

πŸ‘€

Liberty Hamilton

πŸ›

Tim Head

πŸ’¬ πŸ€”

Patricia Herterich

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

Rosie Higman

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

Ian Hinder

πŸ“–

Hieu Hoang

πŸ€”

Dan Hobley

πŸ“–

Chris Holdgraf

πŸ’¬ πŸ€”

Will Hulme

πŸ“–

James Kent

πŸ›

Greg Kiar

πŸ“– πŸ‘€

Danbee Kim

πŸ“–

Anna Krystalli

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

Kevin Kunzmann

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

Mateusz Kuzak

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

Eric Leung

πŸ›

Clare Liggins

πŸ“–

Robin Long

πŸ“–

Christopher Lovell

πŸš‡

Frances Madden

πŸ–‹

Eirini Malliaraki

πŸ“–

Chris Markiewicz

πŸ€”

Carlos Martinez

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

Paula Andrea Martinez

πŸ€” πŸ‘€

Lachlan Mason

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

Rohit Midha

πŸ“–

Javier Moldon

πŸ“–

Beth Montague-Hellen

πŸ“–

Alexander Morley

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

James Myatt

πŸ“–

Oliver Clark

πŸ“–

Martin O'Reilly

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

Jade Pickering

πŸ“–

Camila Rangel Smith

πŸ“–

Rosti Readioff

πŸ“–

James Robinson

πŸ€” πŸ’»

Pablo RodrΓ­guez-SΓ‘nchez

πŸ–‹

Susanna-Assunta Sansone

πŸ“–

Ali Seyhun Saral

πŸ“–

Chanuki Illushka Seresinhe

πŸ“–

Nadia Soliman

πŸ“–

Andrew Stewart

βœ…

Sarah Stewart

πŸ“–

Oliver Strickson

πŸ’¬ πŸ“– βœ…

Natalie Thurlby

πŸ’» ⚠️

Gertjan van den Burg

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

Stefan Verhoeven

πŸ–‹

Kirstie Whitaker

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

Tony Yang

πŸ“– 🌍 πŸš‡

Yo Yehudi

πŸ“– πŸ‘€

Eirini Zormpa

πŸ› πŸ‘€

Malvika Sharan

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

Jim Madge

πŸ–‹

Federico Nanni

πŸ› πŸ–‹

Evelina Gabasova

πŸ› πŸ–‹

Nick Barlow

πŸ› πŸ–‹

Radka Jersakova

πŸ› πŸ–‹

Nathan Begbie

πŸ› πŸ€”

Esther Plomp

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

Anna Hadjitofi

πŸ–‹ 🌍 βœ…

Miguel Rivera

πŸ›

Barbara Vreede

πŸ–‹

Heidi Seibold

πŸ€” πŸ–‹

Max Joseph

πŸ‘€

Martina G. Vilas

πŸš‡ ⚠️

Laura Carter

πŸ‘€ πŸ› πŸ€”

Victoria Dominguez del Angel

πŸ›

Andrea PierrΓ©

πŸ›

Graham Lee

πŸ› πŸ‘€

Mustafa Anil Tuncel

πŸ›

Mark Woodbridge

πŸ€” πŸ–‹

Chad Gilbert

πŸ›

Frances Cooper

πŸ–‹

Joanna Leng

πŸ–‹

Colin Sauze

πŸ€” πŸ–‹

Christina Hitrova

πŸ€”

Kesson Magid

πŸ€”

Arielle Bennett-Lovell

πŸ€” πŸ‘€

Katherine Dixey

πŸ€”

NicolΓ‘s Alessandroni

πŸ€”

Alex Chan

πŸ€”

Neil Chue Hong

πŸ€”

Cameron Trotter

πŸ€”

Carlos Vladimiro GonzΓ‘lez Zelaya

πŸ€”

Pedro Pinto da Silva

πŸ€”

Sedar Olmez

πŸ€”

Rose Sisk

πŸ€”

Natacha Chenevoy

πŸ€”

Paul Dominick Baniqued

πŸ€”

Georgia Atkinson

πŸ€”

Tess Gough

πŸ€”

Annabel Elizabeth Whipp

πŸ€”

Sian Bladon

πŸ€”

Charlotte Watson

πŸ€”

Philip Darke

πŸ€”

Sparkler

🌍

Yini

🌍

Adina Wagner

πŸ–‹

Georgiana Elena

πŸ‘€

Enrico Glerean

πŸ›

Wiebke Toussaint

πŸ›

Danny Garside

πŸ›

Shankho Boron Ghosh

πŸ›

Yash Varshney

πŸ›

Jay Dev Jha

πŸ›

Jeremy Leipzig

πŸ›

Pranav Mahajan

πŸ–‹

Augustinas Sukys

πŸ€”

DerienFe

πŸ€”

Xiaoqing Chen

πŸ€”

takuover

πŸ€”

Srishti Nema

πŸ› πŸ–‹

Victoria

πŸ€”

mjcasy

πŸ€” πŸ–‹

Aditi Shenvi

πŸ€”

ceciledebezenac

πŸ€”

tugceoruc

πŸ€”

vasilisstav

πŸ€”

acork25

πŸ€”

Joe Early

πŸ€”

Georgia Tomova

πŸ€”

swalkoAI

πŸ€”

giuliaok

πŸ€”

sethsh7

πŸ€”

Ferran Gonzalez Hernandez

πŸ€”

alessandroragano

πŸ€”

daniguariso

πŸ€”

kgrieman

πŸ€”

Siba Smarak Panigrahi

πŸ›

Pierre Grimaud

πŸ›

Sumera Priyadarsini

πŸ›

sallyob123

πŸ€”

akira-endo

πŸ€”

Solon

πŸ€”

smasarone

πŸ€”

Risa Ueno

πŸ€”

l-gorman

πŸ€”

Obi Thompson Sargoni

πŸ€”

PeterC-ATI

πŸ€”

Oliver Hamelijnck

πŸ€”

Ismael-KG

πŸ–‹

Tushar Rohilla

πŸ› πŸ–‹

Alex Bird

βœ… πŸ‘€

Eric R Scott

πŸ›

David Foster

πŸ‘€ πŸ›

Markus LΓΆning

πŸ‘€ πŸ–‹

Julien Colomb

πŸ–‹

Samuel Nastase

πŸ›

Raniere Silva

πŸ–‹

Naomi Penfold

πŸ‘€ πŸ€”

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.