diff --git a/.nf-core.yml b/.nf-core.yml index 3db59df..7bbe783 100644 --- a/.nf-core.yml +++ b/.nf-core.yml @@ -39,4 +39,4 @@ template: outdir: . skip_features: - fastqc - version: 1.3.0dev + version: 1.2.1 diff --git a/CHANGELOG.md b/CHANGELOG.md index ae71456..3c319be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## v1.3.0dev +## v1.2.1 - 11-12-2025 - Lemon Fry + +This patch release bumps the required Nextflow version to `>=25.04.0`. ### `Added` @@ -29,7 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### `Deprecated` -## v1.2.0 - 15-01-2024 - Burgundy Piglet +## v1.2.0 - 15-01-2025 - Burgundy Piglet ### `Added` diff --git a/assets/multiqc_config.yml b/assets/multiqc_config.yml index 5e3acb1..8813564 100644 --- a/assets/multiqc_config.yml +++ b/assets/multiqc_config.yml @@ -1,6 +1,5 @@ report_comment: > - This report has been generated by the qbic-pipelines/vcftomaf - analysis pipeline. + This report has been generated by the qbic-pipelines/vcftomaf analysis pipeline. report_section_order: "qbic-pipelines-vcftomaf-methods-description": order: -1000 diff --git a/nextflow.config b/nextflow.config index de4bd92..7b13f31 100644 --- a/nextflow.config +++ b/nextflow.config @@ -263,7 +263,7 @@ manifest { mainScript = 'main.nf' defaultBranch = 'master' nextflowVersion = '!>=25.04.0' - version = '1.3.0dev' + version = '1.2.1' doi = '10.5281/zenodo.10812762' } diff --git a/ro-crate-metadata.json b/ro-crate-metadata.json index b136d52..cbb4cc2 100644 --- a/ro-crate-metadata.json +++ b/ro-crate-metadata.json @@ -21,8 +21,8 @@ { "@id": "./", "@type": "Dataset", - "creativeWorkStatus": "InProgress", - "datePublished": "2025-01-15T13:46:40+00:00", + "creativeWorkStatus": "Stable", + "datePublished": "2025-12-11T10:41:34+00:00", "description": "# ![qbic-pipelines/vcftomaf](docs/images/qbic-pipelines-vcftomaf-logo.png#gh-light-mode-only) ![qbic-pipelines/vcftomaf](docs/images/qbic-pipelines-vcftomaf-logo-dark.png.png#gh-dark-mode-only)\n\n[![Open in GitHub Codespaces](https://img.shields.io/badge/Open_In_GitHub_Codespaces-black?labelColor=grey&logo=github)](https://github.com/codespaces/new/qbic-pipelines/vcftomaf)\n[![GitHub Actions CI Status](https://github.com/qbic-pipelines/vcftomaf/actions/workflows/nf-test.yml/badge.svg)](https://github.com/qbic-pipelines/vcftomaf/actions/workflows/nf-test.yml)\n[![GitHub Actions Linting Status](https://github.com/qbic-pipelines/vcftomaf/actions/workflows/linting.yml/badge.svg)](https://github.com/qbic-pipelines/vcftomaf/actions/workflows/linting.yml)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.10812762-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.10812762)\n[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)\n\n[![Nextflow](https://img.shields.io/badge/version-%E2%89%A525.04.0-green?style=flat&logo=nextflow&logoColor=white&color=%230DC09D&link=https%3A%2F%2Fnextflow.io)](https://www.nextflow.io/)\n[![nf-core template version](https://img.shields.io/badge/nf--core_template-3.5.1-green?style=flat&logo=nfcore&logoColor=white&color=%2324B064&link=https%3A%2F%2Fnf-co.re)](https://github.com/nf-core/tools/releases/tag/3.5.1)\n[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)\n[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)\n[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)\n[![Launch on Seqera Platform](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Seqera%20Platform-%234256e7)](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

\n \n

\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 \\\n --input samplesheet.csv \\\n --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\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": "#42259781-3b96-497c-be64-c9855522795a" + "@id": "#feef81f9-ac6e-48e3-a99f-df780f4e2938" } ], "name": "qbic-pipelines/vcftomaf" @@ -125,14 +125,14 @@ ], "creator": [ { - "@id": "#45968370+famosab@users.noreply.github.com" + "@id": "https://orcid.org/0000-0003-1387-0251" }, { - "@id": "https://orcid.org/0000-0003-1387-0251" + "@id": "#famke.baeuerle@gmail.com" } ], "dateCreated": "", - "dateModified": "2025-01-15T14:46:40Z", + "dateModified": "2025-12-11T11:41:34Z", "dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/", "keywords": [ "nf-core", @@ -141,6 +141,11 @@ "license": [ "MIT" ], + "maintainer": [ + { + "@id": "https://orcid.org/0000-0003-1387-0251" + } + ], "name": [ "qbic-pipelines/vcftomaf" ], @@ -152,10 +157,10 @@ }, "url": [ "https://github.com/qbic-pipelines/vcftomaf", - "https://nf-co.re/qbic-pipelines/vcftomaf/dev/" + "https://nf-co.re/qbic-pipelines/vcftomaf/1.2.1/" ], "version": [ - "1.3.0dev" + "1.2.1" ] }, { @@ -168,14 +173,14 @@ "url": { "@id": "https://www.nextflow.io/" }, - "version": "!>=24.04.2" + "version": "!>=25.04.0" }, { - "@id": "#42259781-3b96-497c-be64-c9855522795a", + "@id": "#feef81f9-ac6e-48e3-a99f-df780f4e2938", "@type": "TestSuite", "instance": [ { - "@id": "#4d23f29a-3ee6-476f-a9a9-9ad0fe3a65ae" + "@id": "#115a4e50-eb3b-4766-bbd8-801b1c99b930" } ], "mainEntity": { @@ -184,10 +189,10 @@ "name": "Test suite for qbic-pipelines/vcftomaf" }, { - "@id": "#4d23f29a-3ee6-476f-a9a9-9ad0fe3a65ae", + "@id": "#115a4e50-eb3b-4766-bbd8-801b1c99b930", "@type": "TestInstance", "name": "GitHub Actions workflow for testing qbic-pipelines/vcftomaf", - "resource": "repos/qbic-pipelines/vcftomaf/actions/workflows/ci.yml", + "resource": "repos/qbic-pipelines/vcftomaf/actions/workflows/nf-test.yml", "runsOn": { "@id": "https://w3id.org/ro/terms/test#GithubService" }, @@ -308,16 +313,16 @@ "url": "https://nf-co.re/" }, { - "@id": "#45968370+famosab@users.noreply.github.com", + "@id": "https://orcid.org/0000-0003-1387-0251", "@type": "Person", "email": "45968370+famosab@users.noreply.github.com", - "name": "Famke Ba\u0308uerle" + "name": "Famke B\u00e4uerle" }, { - "@id": "https://orcid.org/0000-0003-1387-0251", + "@id": "#famke.baeuerle@gmail.com", "@type": "Person", - "email": "45968370+famosab@users.noreply.github.com", - "name": "Famke B\u00e4uerle" + "email": "famke.baeuerle@gmail.com", + "name": "Famke Ba\u0308uerle" } ] } \ No newline at end of file diff --git a/tests/default.nf.test.snap b/tests/default.nf.test.snap index 56b8d6a..7ef635a 100644 --- a/tests/default.nf.test.snap +++ b/tests/default.nf.test.snap @@ -16,7 +16,7 @@ "vcf2maf": "1.6.22" }, "Workflow": { - "qbic-pipelines/vcftomaf": "v1.3.0dev" + "qbic-pipelines/vcftomaf": "v1.2.1" } }, [ diff --git a/tests/vep.nf.test.snap b/tests/vep.nf.test.snap index fd280ab..836f1a8 100644 --- a/tests/vep.nf.test.snap +++ b/tests/vep.nf.test.snap @@ -20,7 +20,7 @@ "ensemblvep": 113.0 }, "Workflow": { - "qbic-pipelines/vcftomaf": "v1.3.0dev" + "qbic-pipelines/vcftomaf": "v1.2.1" } }, [