Skip to main content
Ctrl+K
⚠️The Turing Way is moving domain! We will soon move to book.the-turing-way.org. You can use new domain now! Later, the old domain will redirect you to the new location.
Logo image
  • Welcome
  • Foreword
    • Background
    • Navigating the Handbook
    • Emergence as The Turing Way Strategy
    • Embracing the Principles of Digital Commons
    • Community and Community Roles
    • Governance
    • How to Cite
    • Frequently Asked Questions
  • Guide for Reproducible Research
    • Overview
      • Definitions
      • Added Advantages
      • Barriers
      • Resources
    • Open Research
      • Open Data
      • Open Source Software
      • Open Source Hardware
      • Open Access
      • Open Notebooks
      • Open Scholarship
      • Checklist
      • Resources
    • Version Control
      • Version Control Workflow
      • Version Control and Branches
      • The Git Version Control Software
      • Git for Research Projects
      • Git Using the Command Line
        • Git Commit Command
        • Retrieving and Comparing Versions
        • Git Branches
        • Merging Branches in Git
        • Interactive, Visual Git
        • Git Commands to Work on GitHub
        • Summary Table of Git Commands
      • Version Control for Data
      • Personal Stories
      • Checklist
      • Resources
    • Licensing
      • License Compatibililty
      • Ethics-informed Licensing
      • Data Licenses
      • Hardware Licenses
      • Machine Learning Model Licenses
        • Case Studies: Choosing an ML License
      • Checklist
    • Research Data Management
      • Research Data
      • Finding Data
      • Data Management Plan
      • The FAIR Principles and Practices
      • Personal data management
      • Data Storage and Organisation
      • Data Organisation in Spreadsheets
      • Documentation and Metadata
      • Methods and Protocols
      • Electronic Lab Notebooks (ELNs)
      • Data Curation
      • Data Visualisation
      • Data Repositories
      • Sharing and Archiving Data
      • Data Article
      • Checklist
      • Personal Impact Stories
      • Resources
    • Reproducible Environments
      • Capturing Computational Environments
      • Package Management Systems
      • YAML
      • Virtual Machines
      • Containers
      • Resources and Checklist
    • BinderHub
      • Introduction to BinderHub
      • Compute Resources
      • Build Your Own BinderHub
      • Resources for BinderHub
    • Code quality
      • Code Style and Formatting
      • Writing Robust Code
      • Checklist and Resources
    • Code Testing
      • General Guidance for Testing
      • Overview of Testing Types
      • Smoke Testing
      • Unit Testing
      • Integration Testing
      • System Testing
      • Acceptance and Regression Testing
      • Runtime Testing
      • Test Driven Development
      • Challenges and Exceptional Cases
      • Checklist for Code Testing
      • Further Recommendations
    • Code Reviewing Process
      • Motivation for code reviewing
      • Recommendations for code reviewing
      • Code review workflow
      • Checklist for code reviewing
      • Resources for code reviewing
    • Reusable Code
      • Overview of Code Reuse
      • Detailed Recommendations for Code Reuse
    • Continuous Integration (CI)
      • Intro to Continuous integration (CI)
      • Getting started with GitHub actions
      • Building a Block of a GitHub actions
      • Best practices and recommendations
      • Checklist and Resources
    • Reproducible Research with Make
      • Learn "Make" by examples
      • Debugging Makefiles
      • Case Study of a Reproducible Paper
      • Including numerical results and tables
      • Resources for "Make"
      • Appendix
    • Research Compendia
    • Risk Assessment
      • Complexity and Impact of Risk Assessment
      • Summary of Risk Assessment
    • Case Studies
      • A Statistical Methods Manuscript
  • Guide for Project Design
    • Overview of Project Design
      • Planning for Project Design
      • Collaborative project documentation
      • Reproducibility Methods
      • Version Control and Documentation
      • Sharing Your Research Work
    • Project Design Checklist
    • Creating Project Repositories
      • Landing Page - README File
      • Roadmapping
      • Contributors and Communication Pathways
      • Participation Guidelines
      • Advanced Structure for Data Analysis
      • Further Recommendations
    • Personas and Pathways
      • Persona Creation Tool
      • Contributor Pathways
    • File Naming Convention
    • Code Styling and Linting
      • Guidelines for Code Styling
      • Writing Human Readable Code
      • Code Styling Tools
    • Sensitive Data Projects
      • Types of Sensitive Data
      • Personal Data
      • Confidential Data
      • Biological Data
      • Metadata
      • Combined Datasets
    • Managing Sensitive Data Projects
      • Informed consent
      • Data Privacy Strategies
      • Sharing Sensitive Data
      • Resources
    • Working on Sensitive Data Projects
      • Working with Trusted Research Environments
      • Privacy Preserving Machine Learning
      • Keeping Sensitive Files Secure
      • Sharing Your Jupyter Notebook
      • Removing Sensitive Data From GitHub
      • Further Recommendations
    • Data Governance
      • Data Governance for the Machine Learning Pipeline
      • BigCode Data Governance Case Study
    • Missing Data Handling
      • Missing Data Structures
      • Visualising Missingness
      • Missing Data Handling Methods
      • Structured Missingness
      • Checklist and Resources
    • Risks of Bias in Research
      • Identifying Risks of Bias
      • Confounding Variables
      • Validation and Generalisability
      • Discrimination and Bias
  • Guide for Communication
    • Overview of Guide for Communication
      • Principles of Communicating with Wider Audiences
      • Communicating Accessibly
      • Resources and Recommendations
    • Open Scholarship
      • Open Education
    • Blogs for Research Communication
      • Building a Webpage for Blogs
      • Personal stories - Blogs
    • Lay Summaries
      • Personal Stories - Lay summaries
    • Podcasts for Research Communication
      • Personal Stories - Podcasts
    • Presenting Posters and Conference Talks
      • Presenting at Remote Events
      • Personal stories - Presenting Outside of Your Discipline
    • Social Media for Research Communications
      • Tips for starting with X
      • Managing multiple X accounts
    • Research Objects in Action
      • Lifecycle
      • Implementation
    • Making Research Objects Citable
      • Steps for Making Research Objects Citable
      • Citing Research Objects
      • Software citation with CITATION.cff
      • Create a CITATION.cff using CFFinit
      • Linking Research Objects
      • ORCID to Collect your Research Objects
      • Checklists and Resources
    • Publishing Different Article Types
      • Data Papers
      • Methods Papers
      • Micropublishing
      • Registered Reports
      • Software Papers
    • Communications in Open Source Projects
      • Issue Tracking
      • Communication Channels
    • Authorship and Contributions on Academic Articles
      • Overview of Academic Authorship
      • Types of Authorship Misconduct
      • Discipline Specific Authorship Traditions
      • Large and Equitable Authorships
      • Tips on How to Get Authorship Right
      • Personal Stories - Authorship on Interdisciplinary Projects
      • Personal Stories - Large Collaborative Research Community
      • Resources
    • Peer Review
      • Peer Review
      • Open Peer Review
      • Guidance on Peer Review for a Journal
      • Guidance on Code Review
      • Resources
    • Binder
      • Zero-to-Binder
  • Guide for Collaboration
    • Getting Started With GitHub
      • Motivation for Using GitHub
      • First steps on GitHub
      • Using more GitHub features
      • Advanced GitHub features
    • Maintainers and Reviewers on GitHub
      • Project Maintenance
      • Ownership and Permissions
      • Reviewing Contributions
      • Merging Contributions
      • Resources
    • Organising Meetings
    • Organising Online Coworking Calls
    • Organising Conferences
      • Registration Forms
      • Template for Registration Form
    • Chairing Events
    • Participating in Events
    • Hosting Events with Public Contributors
      • Planning your PPIE Event
      • Location and Venue Planning
      • Scheduling and Agenda Considerations
      • Communication Strategy and Planning
      • Inclusive Social and Networking
      • Technology Considerations
      • Additional Resources
    • Informal Coffee Chats
    • Tools for Facilitating Collaboration
    • Facilitating Stakeholder Engagement
    • Managing a New Community and Team
      • Guide to Planning a Community
      • Addressing Technical Issues
      • Valuing Diversity and Differences
      • Teamwork
    • Academic-Industry Collaborations
      • Establishing an Academic-Industry Collaboration
      • Community Building in an Academic-Industry Collaboration
      • Case Studies and Best Practices in Academic-Industry Collaboration
        • Case Study Library
        • Online Resources
    • Ambassador Schemes
      • Establishing and Running an Ambassador Scheme
      • Turing-Roche Community Scholar Scheme Personal Story
    • Team Manual
      • On and Offboarding Team Members
    • Open Leadership in Data Science
      • Important Features of Leadership
      • Building Healthy Leadership Skills
      • Creating Leadership Opportunities
      • Personal Story from Running a Hackathon
      • Personal Story of Leadership by a Data Librarian
    • Research Infrastructure Roles
      • Community Managers Overview
      • Data Stewards Overview
      • Data Steward Personal Story
      • Data Wrangler Overview
      • Research Software Engineers Overview
      • Research Software Engineering Personal Story
      • Research Application Manager Overview
      • Research Infrastructure Developer Overview
    • Remote Collaboration
      • Pros and Cons
      • Guidelines for Remote Collaboration
      • Managing Distributed Teams
      • Useful Resources
    • Hybrid Collaboration
      • Challenges faced during Hybrid Collaboration
      • Guidelines for Hybrid Collaboration
      • Resources
    • Shared Ownership in Open Source Projects
      • Project Ownership
      • Shared Ownership Models
      • Challenges with Applying Ownership Models Retroactively
      • Nudging for a Better Default
    • Sustainability of Open Source Projects
      • Examples of Open Source Business Models
  • Guide for Ethical Research
    • Introduction to Research Ethics
    • Research Ethics Committees Workflows
    • Ethical Decisions in Preclinical Research
    • Law, Policy and Human Rights in Ethics
      • Ethics and law
      • Human rights
      • Further Recommendations
    • Research Ethics for Social Data
    • Data Feminism
      • Examining Power
    • Activism for Researchers
      • Unionisation
      • Whistleblowing
      • Cultural change
      • The Environmental Impact of Digital Research
      • Case study - Robodebt
      • Case study - Google Workers
    • Internal Policy Advocacy
    • Self-Reflection
      • Identity and Positionality
      • Power and Privilege
      • Self-Reflection Prompts
      • Resources
    • Data-Hazards
      • Introduction
      • How To Use
      • Case Study
    • Ethical Considerations for Open Source Governance Models
  • Community Handbook
    • Code of Conduct
      • Code of Conduct in Detail
      • Incident Reporting Guideline
      • Enforcement Manual
      • Acknowledgements
    • Style Guide
      • Citing and Referencing External Resources
      • Cross-Referencing Sections and Chapters
      • Using Figures
      • Glossary, Special Blocks and More Styling
      • Custom Styling
    • Maintaining Consistency
      • Formatting
      • Structure
      • Language
    • Build the Turing Way Book locally
    • Contributing and Developing Chapters - Templates and Workflow
      • Templates
      • Workflow
    • Acknowledging Contributors
      • Community Members and Shared Ownership
      • Record of Contributions
      • Different Contributions and Acknowledgements
    • Translation and Localisation
      • Translation of Open Source Projects
      • Welcome to the Translation and Localisation Team of The Turing Way!
      • Embark on Your Localisation Journey
      • Your Gateway to Crowdsourced Localisation
    • Infrastructure
      • Publishing Contributors
      • External Link Checking
      • DNS
    • Accessibility
      • Event Organising
      • Alt text
    • Communication Platforms
      • Quick Start Guide for Slack
      • Slack Welcome Guide
    • Monthly Newsletters
      • A Process of Creating a newsletter
      • Newsletter's Style Guide
      • The Turing Way Newsletter Template
    • Book Dash Events
      • Application and Review Process
      • Book Dash Logistics
      • Working With an Illustrator
      • Participant Selection Process
      • Book Dash Main Event Plans
      • After the Book Dash
    • Community Coworking Calls
      • Background, Motivations, and Techniques
      • Online Collaboration Cafe
      • Weekly Coworking Calls
      • Organising coworking calls
      • Drop-in Sessions
    • Fireside Chat Series
      • Fireside Chat Planning Checklist
      • Fireside Chat Roles and Responsibilities
    • Giving a Turing Way Talk
    • Template Collection
      • Book Dash Main Shared Document
      • Book Dash Pre-event Onboarding
      • Book Dash GitHub Session
      • Book Dash Template for Shared Notes
      • Book Dash Template for Feedback
      • Online Collaboration Cafe Templates
      • Weekly Coworking Call Template
      • Template for Drafting Newsletters
      • Template for Fireside Chat Shared Notes
  • Afterword
    • Legal Disclaimer
    • Data Usage Statement
    • Contributors Record
    • Collaborators
    • Sub-projects, Working Groups, Informal Initiatives
    • Glossary
    • Bibliography
  • Repository
  • Suggest edit
  • Open issue
  • .md

Navigating The Turing Way

Contents

  • The Turing Way Guides
    • Community Handbook
    • Foreword and Afterword
  • Areas of Work and Scope
    • Scope of The Turing Way

Navigating The Turing Way#

The Turing Way handbook is a collection of different guides on data science practices and additional sections to cover different aspects of the project and community approaches. Each section contains multiple chapters, and each chapters are divided into smaller, self-contained sub-chapters to allow you to navigate the book and its content easily at your own pace.

The Turing Way Guides#

All community-developed resources on research and data science practices are organised into five guides. The book started with a guide on research reproducibility, that contains tools, methods and practices from computational aspects of data science. Other guides contain different socio-technical aspects that should be considered to make data science open, collaborative and ethical, hence, ultimately enhancing the reproducibility of a project.

  • Guide for Reproducible Research

  • Guide for Project Design

  • Guide for Communication

  • Guide for Collaboration

  • Guide for Ethical Research

_The Turing Way_ Guide to reproducible research and its structure illustrated to show a set of doors to represent how it's built on chapters and sub-chapters of the different areas of the guide

Fig. 4 The Turing Way project illustration by Scriberia. Original version on Zenodo. http://doi.org/10.5281/zenodo.3695300.#

The decision to integrate different chapters into specific guides is made by community members through open discussions via GitHub issues and Slack. However, their positions within the book are simply for organisation and access purposes; the guide itself doesn’t limit the scope of the chapters and hence can be edited and updated by anyone (including you!) at any time with relevant information.

Reminder

The Turing Way is not meant to be read from beginning to end!

Community Handbook#

All community processes are captured in Community Handbook to provide workflows, guidelines, participatory methods, templates and resources used in various aspects of community management in The Turing Way.

Foreword and Afterword#

We have also developed Foreword and Afterword to share contexts, backgrounds and supplementary resources from and about The Turing Way.

Chapters in the Community Handbook, Foreword and afterword are written by both the project delivery team and community members involved in the different leadership, maintenance or community support roles.

Browse the different guides and sections that make up the book, or use the search box to search for whatever you would like to learn about first.

Areas of Work and Scope#

The Turing Way is continually evolving to meet the needs and interests of the community across the following areas of work:

  1. Engage diverse stakeholders in The Turing Way through open, inclusive and collaborative efforts, fostering a community that collectively shapes research and scientific discourse in data science and AI.

  2. Co-create, maintain, and sustain an open-source, community-driven handbook on data science, providing tools, practices and real-world examples of open and reproducible research.

  3. Advocate for responsible and ethical practices, promoting transparency, fostering accountability and embedding human rights principles throughout the lifecycle of research, data science and AI projects.

  4. Champion best practices in communication, collaboration, and project design as fundamental pillars for making data science and AI accessible, comprehensible, and beneficial for all stakeholders.

Scope of The Turing Way#

The scope of The Turing Way can be broadly described across six categories, with practices and resources shared openly in the book:

  1. The Turing Way Book: Disseminating best practices, examples, and recommendations openly in chapters covering reproducible research, communication, collaboration, project design, ethics, and community.

  2. The Turing Way Community: Fostering a diverse and international community, encouraging contributions, building upon existing knowledge, and collaboratively advancing best practices in data science.

  3. Open Leadership: Promoting open leadership by providing community infrastructure, processes, and resources for individuals from diverse backgrounds and interests to lead and connect a decentralised network of actors and their efforts.

  4. Domain Expertise: Collaborating with representatives and experts who contextualise and share The Turing Way resources in their respective domains.

  5. Project Partnership: Proactively partnering with organisations and projects aligned with our vision and mission, combining knowledge, expertise, and resources for the shared benefits of our communities.

  6. Global Impact: Extending the impact of The Turing Way by conducting global outreach, engaging with different sectors, supporting the localisation of resources, advocating for policy changes and facilitating cross-community efforts

Get Involved: If you have ideas and plans for The Turing Way, please reach out to The Turing Way team via email at turingway@turing.ac.uk. Your input is valuable to the ongoing development of the project.

previous

Background

next

Emergence as The Turing Way’s Strategy

Contents
  • The Turing Way Guides
    • Community Handbook
    • Foreword and Afterword
  • Areas of Work and Scope
    • Scope of The Turing Way

By The Turing Way Community

The Turing Way Community makes all of their materials publicly available under open source licenses