-
Notifications
You must be signed in to change notification settings - Fork 417
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.
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
Dsl2 refactor #338
Dsl2 refactor #338
Changes from 39 commits
a6203ed
8ae205c
deb6fcb
d5eccfd
aa60a0e
8654fa5
7c5c975
1a3c194
41e8889
b3695bb
6cc20f1
eb50c10
b4225b8
84a297b
c9e35ab
2739e4e
5ce928f
a848c69
308dfc9
53c14a3
6bce561
9cb6cdc
a219405
c9ba13e
6e0971b
d2d36dc
0fc5a05
bc7bd84
bf838da
131e948
21e3745
0b5ab05
fbb9afc
dd38bae
c8bb74a
44cdf21
3f66150
4c47582
ae2d6b8
b8c379c
f4b8b43
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,8 +2,6 @@ name: nf-core CI | |
# This workflow runs the pipeline with the minimal test dataset to check that it completes without any syntax errors | ||
on: | ||
push: | ||
branches: | ||
- dev | ||
pull_request: | ||
release: | ||
types: [published] | ||
|
@@ -21,6 +19,7 @@ jobs: | |
matrix: | ||
# Nextflow versions: check pipeline minimum | ||
nxf_ver: ['20.11.0-edge'] | ||
engine: ['docker'] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. any reason to not add singularity and conda? To keep the tests short? I am just thinking that given we pull from 3 different sources now, this could catch incorrect urls and such quickly There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. random spaces accidentally added somewhere in between has caused me a few issues here and there 😄 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Plan is to do that, but not implemented yet |
||
steps: | ||
- name: Check out pipeline code | ||
uses: actions/checkout@v2 | ||
|
@@ -31,9 +30,12 @@ jobs: | |
run: | | ||
wget -qO- get.nextflow.io | bash | ||
sudo mv nextflow /usr/local/bin/ | ||
- name: Run --help | ||
run: | | ||
nextflow run ${GITHUB_WORKSPACE} -profile test,${{ matrix.engine }} --help | ||
- name: Run pipeline with test data | ||
run: | | ||
nextflow run ${GITHUB_WORKSPACE} -profile test,docker | ||
nextflow run ${GITHUB_WORKSPACE} -profile test,${{ matrix.engine }} | ||
- name: Show results | ||
run: ls -lR results | ||
|
||
|
This file was deleted.
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -2,17 +2,20 @@ | |||||
|
||||||
> **An open-source analysis pipeline to detect germline or somatic variants from whole genome or targeted sequencing** | ||||||
|
||||||
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A520.11.0--edge-brightgreen.svg)](https://www.nextflow.io/) | ||||||
[![nf-core](https://img.shields.io/badge/nf--core-pipeline-brightgreen.svg)](https://nf-co.re/) | ||||||
[![DOI](https://zenodo.org/badge/184289291.svg)](https://zenodo.org/badge/latestdoi/184289291) | ||||||
|
||||||
[![GitHub Actions CI status](https://github.com/nf-core/sarek/workflows/nf-core%20CI/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22nf-core+CI%22) | ||||||
[![GitHub Actions Linting status](https://github.com/nf-core/sarek/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22nf-core+linting%22) | ||||||
[![GitHub Actions CI Status](https://github.com/nf-core/sarek/workflows/nf-core%20CI/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22nf-core+CI%22) | ||||||
[![GitHub Actions Linting Status](https://github.com/nf-core/sarek/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/sarek/actions?query=workflow%3A%22nf-core+linting%22) | ||||||
[![CircleCi build status](https://img.shields.io/circleci/project/github/nf-core/sarek?logo=circleci)](https://circleci.com/gh/nf-core/sarek/) | ||||||
<!-- [![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/sarek/results) --> | ||||||
|
||||||
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A520.11.0--edge-23aa62.svg)](https://www.nextflow.io/) | ||||||
[![Run with Conda](http://img.shields.io/badge/run%20with-conda-3EB049?logo=anaconda)](https://docs.conda.io/en/latest/) | ||||||
[![Run with Docker](https://img.shields.io/badge/run%20with-docker-0db7ed?logo=docker)](https://www.docker.com/) | ||||||
[![Run with Singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg)](https://sylabs.io/docs/) | ||||||
|
||||||
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](https://bioconda.github.io/) | ||||||
[![Docker](https://img.shields.io/docker/automated/nfcore/sarek.svg)](https://hub.docker.com/r/nfcore/sarek) | ||||||
[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.1400710-1073c8)](https://doi.org/10.5281/zenodo.1400710) | ||||||
[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23sarek-4A154B?logo=slack)](https://nfcore.slack.com/channels/sarek) | ||||||
[![Follow on Twitter](http://img.shields.io/badge/twitter-%40nf__core-1DA1F2?logo=twitter)](https://twitter.com/nf_core) | ||||||
[![Watch on YouTube](http://img.shields.io/badge/youtube-nf--core-FF0000?logo=youtube)](https://www.youtube.com/c/nf-core) | ||||||
|
||||||
## Introduction | ||||||
|
||||||
|
@@ -22,12 +25,28 @@ Sarek can also handle tumour / normal pairs and could include additional relapse | |||||
|
||||||
The pipeline is built using [`Nextflow`](https://www.nextflow.io), a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with `Docker` containers making installation trivial and results highly reproducible. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It comes with 'Docker'... is this still up-to date or should we add the other container engines, since we don't have a monolithic Docker file anymore? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch, we might need to update the TEMPLATE There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. that was fast 🚒 |
||||||
|
||||||
<!-- On release, automated continuous integration tests run the pipeline on a [full-sized dataset](https://github.com/nf-core/test-datasets/tree/sarek#full-test-dataset-origin) on the AWS cloud infrastructure. | ||||||
This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources. | ||||||
The results obtained from the full-sized test can be viewed on the [nf-core website](https://nf-co.re/sarek/results). --> | ||||||
|
||||||
It's listed on [Elixir - Tools and Data Services Registry](https://bio.tools/nf-core-sarek) and [Dockstore](https://dockstore.org/workflows/github.com/nf-core/sarek). | ||||||
|
||||||
## Pipeline Summary | ||||||
|
||||||
By default, the pipeline currently performs the following: | ||||||
|
||||||
* Sequencing quality control (`FastQC`) | ||||||
* Map Reads to Reference (`BWA mem`) | ||||||
* Mark Duplicates (`GATK MarkDuplicatesSpark`) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be MarkDuplicates due to param changes
Suggested change
|
||||||
* Base (Quality Score) Recalibration (`GATK BaseRecalibrator`, `GATK ApplyBQSR`) | ||||||
* Preprocessing quality control (`samtools stats`) | ||||||
* Preprocessing quality control (`Qualimap bamqc`) | ||||||
* Overall pipeline run summaries (`MultiQC`) | ||||||
|
||||||
<p align="center"> | ||||||
<img title="Sarek Workflow" src="docs/images/sarek_workflow.png" width=40%> | ||||||
</p> | ||||||
|
||||||
It's listed on [Elixir - Tools and Data Services Registry](https://bio.tools/nf-core-sarek) and [Dockstore](https://dockstore.org/workflows/github.com/nf-core/sarek). | ||||||
|
||||||
## Quick Start | ||||||
|
||||||
1. Install [`Nextflow`](https://nf-co.re/usage/installation) | ||||||
|
@@ -52,18 +71,6 @@ It's listed on [Elixir - Tools and Data Services Registry](https://bio.tools/nf- | |||||
|
||||||
See [usage docs](https://nf-co.re/sarek/usage) for all of the available options when running the pipeline. | ||||||
|
||||||
## Pipeline Summary | ||||||
|
||||||
By default, the pipeline currently performs the following: | ||||||
|
||||||
* Sequencing quality control (`FastQC`) | ||||||
* Map Reads to Reference (`BWA mem`) | ||||||
* Mark Duplicates (`GATK MarkDuplicatesSpark`) | ||||||
* Base (Quality Score) Recalibration (`GATK BaseRecalibrator`, `GATK ApplyBQSR`) | ||||||
* Preprocessing quality control (`samtools stats`) | ||||||
* Preprocessing quality control (`Qualimap bamqc`) | ||||||
* Overall pipeline run summaries (`MultiQC`) | ||||||
|
||||||
## Documentation | ||||||
|
||||||
The nf-core/sarek pipeline comes with documentation about the pipeline: [usage](https://nf-co.re/sarek/usage) and [output](https://nf-co.re/sarek/output). | ||||||
|
@@ -110,23 +117,19 @@ Helpful contributors: | |||||
* [pallolason](https://github.com/pallolason) | ||||||
* [silviamorins](https://github.com/silviamorins) | ||||||
|
||||||
## Contributions & Support | ||||||
|
||||||
If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md). | ||||||
|
||||||
For further information or help, don't hesitate to get in touch on the [Slack `#sarek` channel](https://nfcore.slack.com/channels/sarek) (you can join with [this invite](https://nf-co.re/join/slack)), or contact us: [Maxime Garcia](mailto:maxime.garcia@scilifelab.se?subject=[GitHub]%20nf-core/sarek), [Szilvester Juhos](mailto:szilveszter.juhos@scilifelab.se?subject=[GitHub]%20nf-core/sarek) | ||||||
|
||||||
## CHANGELOG | ||||||
|
||||||
* [CHANGELOG](CHANGELOG.md) | ||||||
|
||||||
## Acknowledgements | ||||||
|
||||||
[![Barntumörbanken](docs/images/BTB_logo.png)](https://ki.se/forskning/barntumorbanken) | [![SciLifeLab](docs/images/SciLifeLab_logo.png)](https://scilifelab.se) | ||||||
:-:|:-: | ||||||
[![National Genomics Infrastructure](docs/images/NGI_logo.png)](https://ngisweden.scilifelab.se/) | [![National Bioinformatics Infrastructure Sweden](docs/images/NBIS_logo.png)](https://nbis.se) | ||||||
[![QBiC](docs/images/QBiC_logo.png)](hhttps://www.qbic.uni-tuebingen.de) | | ||||||
|
||||||
## Contributions & Support | ||||||
|
||||||
If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md). | ||||||
|
||||||
For further information or help, don't hesitate to get in touch on the [Slack `#sarek` channel](https://nfcore.slack.com/channels/sarek) (you can join with [this invite](https://nf-co.re/join/slack)), or contact us: [Maxime Garcia](mailto:maxime.garcia@scilifelab.se?subject=[GitHub]%20nf-core/sarek), [Szilvester Juhos](mailto:szilveszter.juhos@scilifelab.se?subject=[GitHub]%20nf-core/sarek) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Citations | ||||||
|
||||||
If you use `nf-core/sarek` for your analysis, please cite the `Sarek` article as follows: | ||||||
|
@@ -143,4 +146,7 @@ You can cite the `nf-core` publication as follows: | |||||
> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen. | ||||||
> | ||||||
> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x). | ||||||
> ReadCube: [Full Access Link](https://rdcu.be/b1GjZ) | ||||||
|
||||||
## CHANGELOG | ||||||
|
||||||
* [CHANGELOG](CHANGELOG.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this now running on all branches? or none?