nf-core / test-datasets

Test data to be used for automated testing with the nf-core pipelines
https://nf-co.re
MIT License
105 stars 353 forks source link
nextflow nf-core pipelines test-data test-datasets testing workflow

nfcore/test-datasets

Test data to be used for automated testing with the nf-core pipelines

⚠️ Do not merge your test data to master! Each pipeline has a dedicated branch (and a special one for modules)

Introduction

nf-core is a collection of high quality Nextflow pipelines. This repository contains various files for CI and unit testing of nf-core pipelines and infrastructure.

The principle for nf-core test data is as small as possible, as large as necessary. Please see the guidelines for more detailed information. Always ask for guidance on the nf-core slack before adding new test data.

Documentation

nf-core/test-datasets comes with documentation in the docs/ directory:

  1. Add a new test dataset
  2. Use an existing test dataset

Downloading test data

Due the large number of large files in this repository for each pipeline, we highly recommend cloning only the branches you would use.

git clone <url> --single-branch --branch <pipeline/modules/branch_name>

To subsequently clone other branches[^1]

git remote set-branches --add origin [remote-branch]
git fetch

Support

For further information or help, don't hesitate to get in touch on our Slack organisation (a tool for instant messaging).

[^1]: From stackoverflow