diff --git a/.github/markdownlint.yml b/.github/markdownlint.yml index 8f97a170e8..9a0066d6f0 100644 --- a/.github/markdownlint.yml +++ b/.github/markdownlint.yml @@ -9,4 +9,5 @@ no-duplicate-header: siblings_only: true no-inline-html: allowed_elements: - - img \ No newline at end of file + - img + - p \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 436428b1c0..e39a31024d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - [#41](https://github.com/nf-core/sarek/pull/41) - Update `qualimap` from `2.2.2b` to `2.2.2c` - [#41](https://github.com/nf-core/sarek/pull/41) - Update `tiddit` from `2.7.1` to `2.8.0` - [#41](https://github.com/nf-core/sarek/pull/41) - Update `vcfanno` from `0.3.1` to `0.3.2` +- [#45](https://github.com/nf-core/sarek/pull/45) - Include Workflow figure in `README.md` ### `Fixed` diff --git a/README.md b/README.md index 0de61ba17c..d689576f19 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,9 @@ [![Join us on Slack](https://img.shields.io/badge/slack-nfcore/sarek-blue.svg)](https://nfcore.slack.com/messages/CGFUX04HZ/) - ## Introduction - + Previously known as the Cancer Analysis Workflow (CAW), Sarek is a workflow designed to run analyses on whole genome or targeted sequencing data from regular samples or tumour / normal pairs and could include additional relapses. @@ -29,6 +28,10 @@ across multiple compute infrastructures in a very portable manner. Software dependencies are handled using [Conda](https://conda.io/), [Docker](https://www.docker.com) or [Singularity](https://www.sylabs.io/singularity/) - environment/container technologies that provide excellent reproducibility and ease of use. Thus making installation trivial and results highly reproducible. +

+ +

+ It's listed on the [Elixir - Tools and Data Services Registry](https://bio.tools/Sarek), [Dockstore](https://dockstore.org/workflows/github.com/nf-core/sarek) and [omicX - Bioinformatics tools](https://omictools.com/sarek-tool). ## Documentation diff --git a/docs/images/sarek_workflow.png b/docs/images/sarek_workflow.png new file mode 100644 index 0000000000..f7f019de0c Binary files /dev/null and b/docs/images/sarek_workflow.png differ diff --git a/docs/images/sarek_workflow.svg b/docs/images/sarek_workflow.svg new file mode 100644 index 0000000000..31981409ef --- /dev/null +++ b/docs/images/sarek_workflow.svg @@ -0,0 +1,3675 @@ + + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +r + + + + + + + + +fastqfastqfastqbambambamvcfvcfvcfBased on GATK Best PracticesPreprocessing + + +• HaplotypeCaller Strelka2• Manta, TIDDITVariant Calling• Freebayes, Mutect2 Strelka2• Manta• ASCAT, Control-FREECsnpEff, VEPsnpEff, VEPAnnotation + + +Reports + + +2.5 \ No newline at end of file