The Handbook

The Handbook #

Welcome to Hedmad’s Handbook of Nice and Practical Tips! 🎉

This handbook aims to:

  • Collect useful and practical day-to-day tips on how to conduct bioinformatics analyses;
  • Set standards for data formats, workflows, project structure and code;
  • Provide practical guidelines on how to follow FAIR data and code principles.
  • Serve as a discussion hub for all the above through GitHub’s collaboration features.

The Handbook is not meant to be read top-to-bottom, but navigated to the topic that you are interested of the most. Use the sidebar index to quickly jump to what page you’d like to read.

Contributing to the handbook #

The handbook is a collaborative effort, and we welcome all contributions: from new pages, to edits, to typo fixes, to simple discussion. For more information, head on over to the Handbook’s GitHub repository.

Using the handbook #

The handbook is mainly useful for bioinformaticians, but it is completely open-source, accessible and copy-paste-friendly. The handbook is licensed under the permissive CC-BY 4.0 license. All standalone code in the book is licensed under the MIT license, you can do basically what you want to do with it, but do give us credit.

For more information on the license, please go to the Handbook’s GitHub repository.

Citing the handbook #

If you ever need (or want) to cite us, use the following DOI:

COMING SOON!

We are not alone in here… #

This is not the first handbook of its kind, of course. Other very useful online resources are:

  • The Turing Way: The handbook for reproducible, ethical and collaborative data science. Many handbook pages are written with it in mind.

Contributions #

Thanks to everyone who contributed to the handbook! A list of contributors can be found in the GitHub Readme file.

The Index #

Calendar December 5, 2023