| title | subtitle | menu | ||||
|---|---|---|---|---|---|---|
Workflow name |
Names should be lower case and without punctuation. |
|
All nf-core pipelines must have consistent naming that adhere to the following rules:
- Lower case only
- No special characters (a-z only)
- Descriptive and intuitive
- Must not clash with different data or analysis types
The first two points are to to maximise compatibility with other platforms, so that the pipeline assets are named consistently across systems.
We strongly recommend that names are self-descriptive towards the data or analysis type the pipeline will be using or performing. Users of the pipeline should be able to get a good idea of what the pipeline does from just the name.
Names must be approved by the nf-core community (#new-pipelines).
Please refer to your pipeline with the nf-core prefix in written materials, for example nf-core/yourpipeline.
:::note We are aware that some nf-core pipelines don't follow this requirement, notably nf-core/sarek and nf-core/eager. These pipelines predate nf-core and were part of it's initial creation. :::