Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Guidelines update #165

Merged
merged 4 commits into from Aug 13, 2019
Merged

Guidelines update #165

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b04d260
Guidelines: Expand section on size and specificity
ewels Aug 13, 2019
ca128c3
Guidelines: Elaboration and examples for common usage
ewels Aug 13, 2019
88d157e
Primary, not typical
ewels Aug 13, 2019
9a3c10c
Update markdown/developers/guidelines.md
ewels Aug 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 17 additions & 4 deletions markdown/developers/guidelines.md
View file
Open in desktop
Expand Up @@ -8,12 +8,22 @@ subtitle: Guidelines and requirements for nf-core pipelines.
If you're thinking of adding a new pipeline to nf-core, please read the documentation
about [adding a new pipeline](/developers/adding_pipelines).

## Workflow size
## Workflow size and specificity

We aim to have a _"not too big, not too small"_ rule with nf-core pipelines.
This is a little fuzzy, but as a rule of thumb workflows should contain at
least three different processes and be simple enough to run that a new user
This is deliberately fuzzy, but as a rule of thumb workflows should contain at
least three processes and be simple enough to run that a new user
can realistically run the pipeline after spending ten minutes reading the docs.
Pipelines should be general enough to be of use to multiple groups and research
projects, but comprehensive enough to cover most steps in a primary analysis.

Different pipelines should not overlap one another too much. For example, having
multiple choices for tools and parameters to do the same tasks should be contained
in a single pipeline with varying parameters. However, if the purpose of the
pipeline tasks and results are different, then this should be a separate pipeline.

The above instructions are subject to interpretation and specific scenarios.
If in doubt, please ask the community for feedback on [Slack](https://nf-co.re/join/slack).

## Minimum requirements

Expand All @@ -25,7 +35,10 @@ All nf-core pipelines _must_ adhere to the following:
* Continuous integration testing
* Stable release tags
* Common pipeline structure and usage
* Run in a single command (not multiple sub-workflows)
* Standard filenames as supplied in the template, such as `main.nf` and `docs/`
* Use the same command line option names as other pipelines for comparable options, _e.g._ `--reads` and `--genome`
* Run in a single command
* _i.e._ Not multiple separate workflows in a single repository
* It is ok to have workflows that use the output of _another_ nf-core pipeline as input
* Excellent documentation and GitHub repository keywords
* A responsible contact person / GitHub username
Expand Down