Giter Club home page Giter Club logo

the-turing-way's Introduction

The Turing Way

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

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.

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

๐Ÿค” ๐Ÿ‘€

Kristijan Armeni

๐Ÿ›

Becky Arnold

๐Ÿ’ฌ ๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿ‘€

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

๐Ÿ“–

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

๐Ÿ“– ๐Ÿค”

Eric Leung

๐Ÿ›

Clare Liggins

๐Ÿ“–

Robin Long

๐Ÿ“–

Christopher Lovell

๐Ÿš‡

Eirini Malliaraki

๐Ÿ“–

Chris Markiewicz

๐Ÿค”

Paula Andrea Martinez

๐Ÿค”

Lachlan Mason

๐Ÿค” ๐Ÿ“– ๐Ÿ’ป

Rohit Midha

๐Ÿ“–

Javier Moldon

๐Ÿ“–

Beth Montague-Hellen

๐Ÿ“–

Alexander Morley

๐Ÿ’ฌ ๐Ÿ‘€ ๐Ÿค” โš ๏ธ

James Myatt

๐Ÿ“–

OliJimbo

๐Ÿ“–

Martin O'Reilly

๐Ÿ’ฌ ๐Ÿ”ง ๐Ÿค”

Jade Pickering

๐Ÿ“–

Camila Rangel Smith

๐Ÿ“–

Rosti Readioff

๐Ÿ“–

James Robinson

๐Ÿค” ๐Ÿ’ป

Susanna-Assunta Sansone

๐Ÿ“–

Ali Seyhun Saral

๐Ÿ“–

Chanuki Illushka Seresinhe

๐Ÿ“–

Nadia Soliman

๐Ÿ“–

Andrew Stewart

โœ…

Sarah Stewart

๐Ÿ“–

Oliver Strickson

๐Ÿ’ฌ ๐Ÿ“–

Natalie Thurlby

๐Ÿ’ป โš ๏ธ

Gertjan van den Burg

๐Ÿ“– ๐Ÿค” ๐Ÿ’ฌ

Kirstie Whitaker

๐Ÿ’ฌ ๐Ÿ“– ๐ŸŽจ ๐Ÿ“‹ ๐Ÿ” ๐Ÿค” ๐Ÿ‘€ ๐Ÿ“ข

Tony Yang

๐Ÿ“–

Yo Yehudi

๐Ÿ“– ๐Ÿ‘€

Malvika Sharan

๐Ÿ“– ๐Ÿ“‹ ๐Ÿค” ๐Ÿ“† ๐Ÿ‘€

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

the-turing-way's People

Contributors

r-j-arnold avatar kirstiejane avatar sgibson91 avatar allcontributors[bot] avatar rainsworth avatar pherterich avatar malvikasharan avatar rosiehigman avatar louiseabowler avatar masonlr avatar clareliggins avatar alexmorley avatar mjg211 avatar jspickering avatar annakrystalli avatar nataliezelenka avatar trallard avatar nadiasoliman avatar alfawolf140 avatar siccarpoint avatar susannasansone avatar tonyyzy avatar jezcope avatar rostireadioff avatar nathanbegbie avatar da5nsy avatar jmgate avatar rjjgilham avatar pranavmahajan25 avatar gjjvdburg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.