-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from famosab/dev
Back to dev
- Loading branch information
Showing
5 changed files
with
28 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,5 +38,5 @@ template: | |
| outdir: . | ||
| skip_features: | ||
| - fastqc | ||
| version: 1.2.0 | ||
| version: 1.3.0dev | ||
| update: | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,8 +21,8 @@ | |
| { | ||
| "@id": "./", | ||
| "@type": "Dataset", | ||
| "creativeWorkStatus": "Stable", | ||
| "datePublished": "2025-01-15T09:03:36+00:00", | ||
| "creativeWorkStatus": "InProgress", | ||
| "datePublished": "2025-01-15T13:46:40+00:00", | ||
| "description": "#  \n\n[](https://github.com/qbic-pipelines/vcftomaf/actions/workflows/ci.yml)\n[](https://github.com/qbic-pipelines/vcftomaf/actions/workflows/linting.yml)[](https://doi.org/10.5281/zenodo.10812762)\n[](https://www.nf-test.com)\n\n[](https://www.nextflow.io/)\n[](https://docs.conda.io/en/latest/)\n[](https://www.docker.com/)\n[](https://sylabs.io/docs/)\n[](https://tower.nf/launch?pipeline=https://github.com/qbic-pipelines/vcftomaf)\n\n## Introduction\n\n**qbic-pipelines/vcftomaf** is a bioinformatics pipeline that converts input Variant Call Format (vcf) files with one or two columns of (paired) samples to tabular Mutation Annotation Format (maf).\nThe resulting file(s) can be analyzed singly or as an entire cohort in R with [maftools](https://github.com/PoisonAlien/maftools).\n\n<p align=\"center\">\n <img title=\"Overview\" src=\"docs/images/metromap.png\" width=60%>\n</p>\n\n1. Optional Filtering of VCF files for PASS and / or with a target bed file ([`BCFtools`](https://github.com/samtools/bcftools))\n2. Optional liftover (needs a `chain` file, `--fasta` should refer to target genome version) ([`Picard LiftOverVCF`](https://gatk.broadinstitute.org/hc/en-us/articles/360037060932-LiftoverVcf-Picard))\n3. Conversion from vcf to maf format([`vcf2maf`](https://github.com/mskcc/vcf2maf))\n4. Collect QC metrics and versions ([`MultiQC`](http://multiqc.info/))\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.\n\nFirst, prepare a samplesheet with your input data that looks as follows:\n\n`samplesheet.csv`:\n\n```csv\nsample,normal_id,vcf_normal_id,tumor_id,vcf_tumor_id,vcf,index\nmutect2_sample1,SAMPLE123,PATIENT1_SAMPLE123,SAMPLE456,PATIENT1_SAMPLE456,/path/to/vcf,/path/to/tbi\ntest2,control2,NORMAl,,,/path/to/vcf,/path/to/tbi\n```\n\nEach row represents a sample with one or two columns in the VCF file. The `normal_id` and `tumor_id` will be used for naming the columns in the MAF file. The `vcf_normal/tumor_id` refers to the sample name in the VCF file. This differs for each caller. For VCFs obtained from nf-core/sarek, the following is tested:\n\n| Caller | Normal ID | Tumor ID |\n| :------- | :---------------------- | :---------------------- |\n| Manta | NORMAL | TUMOR |\n| Mutect2 | {_patient_}_{\\_sample_} | {_patient_}_{\\_sample_} |\n| Strelka2 | NORMAL | TUMOR |\n\nThe values for _patient_ and _sample_ can be obtained from the nf-core/sarek samplesheet.\n\nNow, you can run the pipeline using:\n\n```bash\nnextflow run qbic-pipelines/vcftomaf \\\n -profile <docker/singularity/.../institute> \\\n --input samplesheet.csv \\\n --outdir <OUTDIR>\n```\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;\n> see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).\n\nFor more details and further functionality, please refer to the [usage documentation](docs/usage.md) and the [parameter documentation](nextflow_schema.json).\n\nFor more details about the output files and reports, please refer to the\n[output documentation](docs/output.md).\n\n## Credits\n\nqbic-pipelines/vcftomaf was originally written by [SusiJo](https://github.com/SusiJo), [Friederike Hanssen](https://github.com/FriederikeHanssen) up to release 1.0.0. The pipeline was further developed by [Famke B\u00e4uerle](https://github.com/famosab) after release 1.0.0.\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\n## Citations\n\nIf you use qbic-pipelines/vcftomaf for your analysis, please cite it using the following doi: [10.5281/zenodo.10812762](https://zenodo.org/doi/10.5281/zenodo.10812762)\n\n<!-- TODO nf-core: Add bibliography of tools and data used in your pipeline -->\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nThis pipeline is based on code and infrastructure developed and maintained by the [nf-core](https://nf-co.re) community, reused here under the [MIT license](https://github.com/nf-core/tools/blob/master/LICENSE).\nThe pipeline is currently maintained at QBiC and not an nf-core pipeline since it has not undergone nf-core community review.\n\nYou can cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n", | ||
| "hasPart": [ | ||
| { | ||
|
|
@@ -96,7 +96,7 @@ | |
| }, | ||
| "mentions": [ | ||
| { | ||
| "@id": "#3620cd02-07a3-4ffd-a6da-7423d4ac295c" | ||
| "@id": "#42259781-3b96-497c-be64-c9855522795a" | ||
| } | ||
| ], | ||
| "name": "qbic-pipelines/vcftomaf" | ||
|
|
@@ -125,14 +125,14 @@ | |
| ], | ||
| "creator": [ | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-1387-0251" | ||
| "@id": "#[email protected]" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]" | ||
| "@id": "https://orcid.org/0000-0003-1387-0251" | ||
| } | ||
| ], | ||
| "dateCreated": "", | ||
| "dateModified": "2025-01-15T10:03:36Z", | ||
| "dateModified": "2025-01-15T14:46:40Z", | ||
| "dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/", | ||
| "keywords": [ | ||
| "nf-core", | ||
|
|
@@ -152,10 +152,10 @@ | |
| }, | ||
| "url": [ | ||
| "https://github.com/qbic-pipelines/vcftomaf", | ||
| "https://nf-co.re/qbic-pipelines/vcftomaf/1.2.0/" | ||
| "https://nf-co.re/qbic-pipelines/vcftomaf/dev/" | ||
| ], | ||
| "version": [ | ||
| "1.2.0" | ||
| "1.3.0dev" | ||
| ] | ||
| }, | ||
| { | ||
|
|
@@ -171,11 +171,11 @@ | |
| "version": "!>=24.04.2" | ||
| }, | ||
| { | ||
| "@id": "#3620cd02-07a3-4ffd-a6da-7423d4ac295c", | ||
| "@id": "#42259781-3b96-497c-be64-c9855522795a", | ||
| "@type": "TestSuite", | ||
| "instance": [ | ||
| { | ||
| "@id": "#29a20590-1b60-4510-8668-5dd0633a2175" | ||
| "@id": "#4d23f29a-3ee6-476f-a9a9-9ad0fe3a65ae" | ||
| } | ||
| ], | ||
| "mainEntity": { | ||
|
|
@@ -184,7 +184,7 @@ | |
| "name": "Test suite for qbic-pipelines/vcftomaf" | ||
| }, | ||
| { | ||
| "@id": "#29a20590-1b60-4510-8668-5dd0633a2175", | ||
| "@id": "#4d23f29a-3ee6-476f-a9a9-9ad0fe3a65ae", | ||
| "@type": "TestInstance", | ||
| "name": "GitHub Actions workflow for testing qbic-pipelines/vcftomaf", | ||
| "resource": "repos/qbic-pipelines/vcftomaf/actions/workflows/ci.yml", | ||
|
|
@@ -308,16 +308,16 @@ | |
| "url": "https://nf-co.re/" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-1387-0251", | ||
| "@id": "#[email protected]", | ||
| "@type": "Person", | ||
| "email": "[email protected]", | ||
| "name": "Famke B\u00e4uerle" | ||
| "name": "Famke Ba\u0308uerle" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]", | ||
| "@id": "https://orcid.org/0000-0003-1387-0251", | ||
| "@type": "Person", | ||
| "email": "[email protected]", | ||
| "name": "Famke Ba\u0308uerle" | ||
| "name": "Famke B\u00e4uerle" | ||
| } | ||
| ] | ||
| } | ||