Chapter 2: getting started

Edit

Introduction

In this chapter, we will describe what you will need to successfully complete this training.

Preparation

For this training, you must already be familiar with:

• ✅ Writing Nextflow pipelines
  • Not yet familiar? Try the official Nextflow training
• ✅ How Nextflow modules/processes work
  • Not yet familiar? Read the official Nextflow documentation on modules
• ✅ Have some knowledge of Git and GitHub
  • Not yet familiar with git? Try the official git tutorial
  • Not yet familiar? Try the GitHub Skills documentation

You will need to already have the following installed or created:

• ✅ Nextflow installed
  • Documentation here.
• ✅ nf-core tools installed.
  • Documentation here
• ✅ A Nextflow supported software management system installed
  • Conda (Documentation here)
  • Docker Engine or Desktop (Documentation here)
  • Apptainer (Documentation here)
• ✅ A GitHub account.
• ✅ A fork to your account and clone of the nf-core/modules repository

It also assumes:

• ✅ You have a command-line based tool in mind to make an nf-core module
• ✅ This tool is already installable via Bioconda

Summary

In this chapter, we have outlined what you need to have installed and prepared to successfully complete this training.

In the next chapter we will give an introduction to what defines an nf-core module is.