Skip to content

IARCbioinfo/template-nf

Repository files navigation

Name

Empty template for nextflow pipelines (short description)

CircleCI Docker Hub https://www.singularity-hub.org/static/img/hosted-singularity--hub-%23e32929.svg DOI

Workflow representation

Description

...

Dependencies

  1. This pipeline is based on nextflow. As we have several nextflow pipelines, we have centralized the common information in the IARC-nf repository. Please read it carefully as it contains essential information for the installation, basic usage and configuration of nextflow and our pipelines.
  2. External software:
  • ...
  • ...

You can avoid installing all the external software by only installing Docker. See the IARC-nf repository for more information.

Input

Type Description
input1 ......
input2 ......

Specify the test files location

Parameters

  • Mandatory

Name Example value Description
--param1 xx ......
--param2 xx ......
  • Optional

Name Default value Description
--param3 xx ......
--param4 xx ......
  • Flags

Flags are special parameters without value.

Name Description
--help Display help
--flag2 ....

Usage

...

Output

Type Description
output1 ......
output2 ......

Detailed description (optional section)

...

Directed Acyclic Graph

DAG

Contributions

Name Email Description
contrib1* xx Developer to contact for support (link to specific gitter chatroom)
contrib2 xx Developer
contrib3 xx Tester

References (optional)

FAQ (optional)