Skip to content

sbilge/nextflow-clinvap

Repository files navigation

Clinical Variant Annotation Pipeline.

Nextflow install with bioconda Docker

Introduction

The pipeline is created via nf-core template and built using Nextflow, 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.

Quick Start

i. Install nextflow

ii. Install one of docker, singularity or conda

iii. Download the pipeline and test it on a minimal dataset with a single command

nextflow run KohlbacherLab/nextflow-clinvap -profile test,<docker/singularity/conda/institute>

Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile institute in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.

iv. Start running your own analysis!

nextflow run KohlbacherLab/nextflow-clinvap -profile <docker/singularity/conda/institute> --annotated_vcf <input> --skip_vep true

See usage docs for all of the available options when running the pipeline.

Documentation

The KohlbacherLab/nextflow-clinvap pipeline comes with documentation about the pipeline, found in the docs/ directory:

  1. Installation
  2. Pipeline configuration
  3. Running the pipeline
  4. Output and how to interpret the results
  5. Troubleshooting

Credits

KohlbacherLab/nextflow-clinvap was originally written by Bilge Sürün. It is created using nf-core pipeline template.

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on Slack (you can join with this invite).

Citation

If you use KohlbacherLab/nextflow-clinvap for your analysis, please cite the following article:

Sürün, B., Schärfe, C.P., Divine, M.R., Heinrich, J., Toussaint, N.C., Zimmermann, L., Beha, J. and Kohlbacher, O., 2020. ClinVAP: a reporting strategy from variants to therapeutic options. Bioinformatics, 36(7), pp.2316-2317. https://doi.org/10.1093/bioinformatics/btz924

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published