https://github.com/abelsiqueira/the-turing-way

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

https://github.com/abelsiqueira/the-turing-way

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 14 DOI reference(s) in README
  • Academic publication links
    Links to: scholar.google, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.0%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Fork of the-turing-way/the-turing-way
Created over 4 years ago · Last pushed over 4 years ago

https://github.com/abelsiqueira/the-turing-way/blob/main/



# _The Turing Way_

>_This README.md file in also available in Dutch ([README-Dutch](README-translated/README-Dutch.md)), French ([README-French.md](README-translated/README-French.md)), German ([README-German.md](README-translated/README-German.md)), Indonesian ([README-Indonesian](README-translated/README-Indonesian.md)), Italian ([README-Italian](README-translated/README-Italian.md)), Korean ([README-Korean](README-translated/README-Korean.md)), Portuguese ([README-Portuguese](README-translated/README-Portuguese.md)), and Spanish ([README-Spanish](README-translated/README-Spanish.md)) (listed alphabetically)._

*Total Contributors:*


[![All Contributors](https://img.shields.io/badge/all_contributors-297-orange.svg)](#contributors)


| Information | Links |
| :--- | :--- |
| **Project** | [![Read the book](https://img.shields.io/badge/read-the%20book-blue.svg)](https://the-turing-way.netlify.com) [![](https://img.shields.io/static/v1?label=TuringWay&message=I%20want%20to%20contribute!&color=yellow&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8%2F9hAAACYklEQVQ4jXXTy09TQRTH8f5VPhI1xoVxYURNAFcmRleaGDdGXQlKAYkLUARNfICoScGKpTyE3t5bkKD2AUQepUXB0gcgLTalD9rema8LKRVrT3I2k%2Fl95kwyY6BMfQiFqHaoVDlUBoJBZJl9hn8XRsIhqh0abd55tnWdrBA8WfBSpakMhUqhXUCJhKl2aLR65%2FEtLeGc%2BYoy5aHf46bX7cThctK%2BAw2HQkVAW41wzqHRMjNNRteR%2BQzGjg5udZtQ47FiO50gdLZ1nVbvPNUOFSUSxnB4sJ%2F0TjCTTjHk%2BoJl%2BRtqPEaL6zMH79Rw0dyDVVURqRgyn0EkN8jkshwZGsBQodgQyQ2kyDPsce859drjdqLRKE0D%2FZhHR5F6DpHc2B3%2FjF3BcFqxARIpBXXmt9ii67vAYDhIr8fNx0UfE3OzzC0sIHIpxNYqSPEHqFBsiFQMkU3h8vs5%2FvABTeNje6BCj%2FxcwzLlIZHYROq5v4EoIr2JyCbJ57Kobjd3u7o41v4I68pyCfTGrhSvUKHYAJD5bcTWGjKbJJdO4A8E6JyexP4rWgK8Vkb2AjK7hcxnmZybxfF9kff%2BhZJQofvXwhg7O4vAfU2l79ME79xOrjY3c9ZYVzZs8nvZf6%2BRQCRCTgiODg1iCK6vc6WtjZM1tzlRW8sNa99%2Fx64fH%2BNAQz0un49nfh%2BVmspAcKX4lKWUbMbjXOg2cf3Vy%2BLIoRWqekxc7nhB6%2FQ0lZqKJRBAyjKfKZFIcKixgVPPn3LTamFfUyPne7qp1Oz0Bn4g5d7vVAIUamJ2FqPZzCW7gvlHabBQvwE2XnlAiFRrOwAAAABJRU5ErkJggg%3D%3D)](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md) |
| **News** | [![Twitter Follow](https://img.shields.io/twitter/follow/turingway?style=social)](https://twitter.com/turingway) [![Join our tinyletter mailing list](https://img.shields.io/badge/receive-our%20newsletter%20%EF%B8%8F-blueviolet.svg)](https://tinyletter.com/TuringWay)  [![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCPDxZv5BMzAw0mPobCbMNuA?style=social)](https://www.youtube.com/channel/UCPDxZv5BMzAw0mPobCbMNuA)  |
| **Chat** | [![Join Slack](https://img.shields.io/badge/Chat-on%20Slack-ff69b4)](https://join.slack.com/t/theturingway/shared_invite/zt-fn608gvb-h_ZSpoA29cCdUwR~TIqpBw) [![GitHub issues](https://img.shields.io/github/issues/alan-turing-institute/the-turing-way)](https://github.com/alan-turing-institute/the-turing-way/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/alan-turing-institute/the-turing-way)](https://github.com/alan-turing-institute/the-turing-way/pulls) |
| **Build** | [![Netlify build](https://github.com/alan-turing-institute/the-turing-way/workflows/CI/badge.svg)](https://github.com/alan-turing-institute/the-turing-way/actions?query=workflow%3ACI+branch%3Amain) [![Latin Phrases](https://github.com/alan-turing-institute/the-turing-way/workflows/Check%20for%20Latin%20Phrases/badge.svg)](https://github.com/alan-turing-institute/the-turing-way/actions?query=workflow%3A%22Check+for+Latin+Phrases%22+branch%3Amain) [![TestFileSizes](https://github.com/alan-turing-institute/the-turing-way/workflows/TestFileSizes/badge.svg)](https://github.com/alan-turing-institute/the-turing-way/actions?query=workflow%3ATestFileSizes+branch%3Amain) [![Check for Lorem Ipsums](https://github.com/alan-turing-institute/the-turing-way/workflows/Check%20for%20Lorem%20Ipsums/badge.svg)](https://github.com/alan-turing-institute/the-turing-way/actions?query=workflow%3A%22Check+for+Lorem+Ipsums%22+branch%3Amain) |
| **Cite** |  [![Cite this using DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3233853.svg)](https://doi.org/10.5281/zenodo.3233853) |

*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](book/website/figures/README_imgs/README_turingway.png)](https://docs.google.com/presentation/d/13Nm8LcRW87ffxEugGEs5j6HKQEvhiuH8b7MfIdX7MpI/edit#slide=id.p1).

*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](https://the-turing-way.netlify.app), contribute to the project as described in our [contribution guidelines](https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md) and re-use all materials ([see the License](https://github.com/alan-turing-institute/the-turing-way/blob/main/LICENSE.md)).

[![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.](book/website/figures/README_imgs/README_book.png)](https://the-turing-way.netlify.app/welcome.html)

*Screenshot of The Turing Way online book ([use this image in a presentation](https://drive.google.com/file/d/1wJR664YECSc8b_RSHeyVjDlHs-Ls9lkc/view?usp=sharing))*

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

- [About the project](#about-the-project)
- [The Team](#the-team)
- [Contributing](#contributing)
- [Citing _The Turing Way_](#citing-the-turing-way)
- [Get in touch](#get-in-touch)
- [Contributors](#contributors)

 If you prefer an audio introduction to the project, our team member Rachael presented at the [Open Science Fair 2019](https://www.opensciencefair.eu/) in Porto and her demo was recorded by the [Orion podcast](https://orionopenscience.podbean.com/e/the-fair-is-in-town-figshare-the-turing-way-and-open-science-quest-at-the-osfair2019/).
_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: .

### 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](https://www.turing.ac.uk/).

You can read [_The Turing Way_ acknowledgement process](https://the-turing-way.netlify.app/community-handbook/acknowledgement/acknowledgement-members.html#community-members-contributors-and-co-authors) and [Record of Contributions](https://the-turing-way.netlify.app/afterword/contributors-record.html) to learn about how we acknowledge your work and how our contributors are highlighted in the project.
Please see the [Contributors Table](#contributors) 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](CODE_OF_CONDUCT.md) and to check out our [contributing guidelines](CONTRIBUTING.md) 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](book/website/figures/README_imgs/README_contributions.png)

*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](https://github.com/alan-turing-institute/the-turing-way/tree/main/communications/promotion-pack) to help you in presenting and sharing about _The Turing Way_ in your network.

### Citing _The Turing Way_

You can reference _The Turing Way_ through the project's Zenodo archive using DOI: [10.5281/zenodo.3233853](https://doi.org/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 this:

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

You can also share the human-readable URL to a page in the book, for example, , 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  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).

### 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](https://www.scriberia.co.uk/) as part of [_The Turing Way_ book dashes](https://github.com/alan-turing-institute/the-turing-way/tree/main/workshops/book-dash) 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)](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](https://github.com/apps/welcome)'s responses to new members' contributions in this GitHub repository. ### Get in Touch #### Email You can contact *The Turing Way* team by emailing [theturingway@gmail.com](mailto:theturingway@gmail.com). You can also contact **Malvika Sharan** by emailing [msharan@turing.ac.uk](mailto:msharan@turing.ac.uk) or **Kirstie Whitaker** by emailing [kwhitaker@turing.ac.uk](mailto:kwhitaker@turing.ac.uk). #### Chat Connect with others and discuss your ideas on Slack using [this invitation link](https://join.slack.com/t/theturingway/shared_invite/zt-fn608gvb-h_ZSpoA29cCdUwR~TIqpBw). 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 . The room is also accessible with a [Matrix](https://matrix.org) account at [#alan-turing-institute_the-turing-way:gitter.im](https://matrix.to/#/#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 . You can also follow us on Twitter ([@turingway](https://twitter.com/turingway)). ## Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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


Andrea Pierr


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 Sipcz


Bruno Camino


Callum Mole


Cameron Trotter


Camila Rangel Smith


Carlos Martinez


Carlos Vladimiro Gonzlez 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 Nst


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


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 Leipzig


Jessica


Jessy Provencher


Jez Cope


Jill Wang


Jim Madge


Joanna Leng


Joe Early


Joe Fennell


Joshua Teves


Jos Mara Fernndez


Julia Guiomar Niso Galn


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


Maria Eriksson


Mariam-ke


Mariana V.


Mariona


Mark Woodbridge


Markus Lning


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


Nicols Alessandroni


Nina


Nomi Harris


NotActuallyACat


Obi Thompson Sargoni


Oliver Clark


Oliver Forrest


Oliver Hamelijnck


Oliver Strickson


Oscar Giles


Pablo Rodrguez-Snchez


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


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 kerstrm


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


yaseminturkyilmaz

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Owner

  • Name: Abel Soares Siqueira
  • Login: abelsiqueira
  • Kind: user
  • Location: Amsterdam - The Netherlands
  • Company: Netherlands eScience Center

GitHub Events

Total
Last Year