Development guidelines

This section explains the rules to follow when developing a Modelblocks module in order to comply with our Convention. If you are new to Snakemake workflows, we recommend familiarising yourself with the Snakemake documentation first.

Required reading

We assume you are familiar with the basics of using Modelblocks modules and have a good grasp of Snakemake basics:

• Rules and wildcards
• Modules and pathvars

• Setting up

  How to install all the necessary tools to develop your own Modelblocks module.

• Convention

  An in depth dive into the Modelblocks convention.

• Best practices

  Our preferences for long-lived, successful modules.