-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* prepare release * version correction * prettier
- Loading branch information
Showing
7 changed files
with
44 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
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 |
|---|---|---|
|
|
@@ -44,4 +44,4 @@ template: | |
| - codespaces | ||
| - fastqc | ||
| - adaptivecard | ||
| version: 1.1.0devdev | ||
| version: 1.1.0 | ||
This file was deleted.
Oops, something went wrong.
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,9 +21,9 @@ | |
| { | ||
| "@id": "./", | ||
| "@type": "Dataset", | ||
| "creativeWorkStatus": "InProgress", | ||
| "datePublished": "2024-12-18T13:49:24+00:00", | ||
| "description": "# qbic-pipelines/vcftomat\n\n[](https://github.com/qbic-pipelines/vcftomat/actions/workflows/ci.yml)\n[](https://github.com/qbic-pipelines/vcftomat/actions/workflows/linting.yml)[](https://doi.org/10.5281/zenodo.XXXXXXX)\n\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://cloud.seqera.io/launch?pipeline=https://github.com/qbic-pipelines/vcftomat)\n\n## Introduction\n\n**qbic-pipelines/vcftomat** is a bioinformatics pipeline that processes g.vcf files to a matrix suitable for downstream analysis. The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes data using the following steps:\n\n1. Indexes (g.)vcf files ([`tabix`](http://www.htslib.org/doc/tabix.html))\n2. Converts g.vcf files to vcf with `genotypegvcf` ([`GATK`](https://gatk.broadinstitute.org/hc/en-us))\n3. Changes the sample name in the vcf file to the filename with `bcftools/reheader` ([`bcftools`](https://samtools.github.io/bcftools/bcftools.html)) - This can be turned off by adding `--rename false` to the `nextflow run` command.\n4. Merges all vcfs from the same sample with `bcftools/merge` ([`bcftools`](https://samtools.github.io/bcftools/bcftools.html))\n5. Converts the (merged) vcfs to a matrix using a custom R script written by @ellisdoro ([`R`](https://www.r-project.org/))\n6. Collects all reports into a MultiQC report ([`MultiQC`](http://multiqc.info/))\n\n\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,gvcf,vcf_path,vcf_index_path\nSAMPLE-1,false,path/to/vcf.gz,path/to/.vcf.gz.tbi\nSAMPLE-1,false,path/to/vcf.gz,path/to/.vcf.gz.tbi\nSAMPLE-2,true,path/to/g.vcf.gz,path/to/g.vcf.gz.tbi\n```\n\nEach row represents a VCF file coming from a sample. The `gvcf` column indicates whether the file is a g.vcf file or not. The `vcf_path` and `vcf_index_path` columns contain the path to the VCF file and its index, respectively.\n\nNow, you can run the pipeline using:\n\n```bash\nnextflow run qbic-pipelines/vcftomat \\\n -profile <docker/singularity/.../institute> \\\n --input samplesheet.csv \\\n --genome GATK.GRCh38 \\\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**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n\n## Credits\n\nqbic-pipelines/vcftomat was originally written by Famke B\u00e4uerle, Dorothy Ellis.\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\n<!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. -->\n<!-- If you use qbic-pipelines/vcftomat for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->\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 uses 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/main/LICENSE).\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", | ||
| "creativeWorkStatus": "Stable", | ||
| "datePublished": "2025-01-08T12:21:55+00:00", | ||
| "description": "# qbic-pipelines/vcftomat\n\n[](https://github.com/qbic-pipelines/vcftomat/actions/workflows/ci.yml)\n[](https://github.com/qbic-pipelines/vcftomat/actions/workflows/linting.yml)[](https://doi.org/10.5281/zenodo.XXXXXXX)\n\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://cloud.seqera.io/launch?pipeline=https://github.com/qbic-pipelines/vcftomat)\n\n## Introduction\n\n**qbic-pipelines/vcftomat** is a bioinformatics pipeline that processes g.vcf files to a matrix suitable for downstream analysis. The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes data using the following steps:\n\n1. Indexes (g.)vcf files ([`tabix`](http://www.htslib.org/doc/tabix.html))\n2. Converts g.vcf files to vcf with `genotypegvcf` ([`GATK`](https://gatk.broadinstitute.org/hc/en-us))\n3. Concatenates all vcfs that have the same id and the same label with `bcftools/concat` ([`bcftools`](https://samtools.github.io/bcftools/bcftools.html))\n4. Changes the sample name in the vcf file to the filename with `bcftools/reheader` ([`bcftools`](https://samtools.github.io/bcftools/bcftools.html)) - This can be turned off by adding `--rename false` to the `nextflow run` command.\n5. Merges all vcfs from the same sample with `bcftools/merge` ([`bcftools`](https://samtools.github.io/bcftools/bcftools.html))\n6. Converts the (merged) vcfs to a matrix using a custom R script written by @ellisdoro ([`R`](https://www.r-project.org/))\n7. Collects all reports into a MultiQC report ([`MultiQC`](http://multiqc.info/))\n\n\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,label,gvcf,vcf_path,vcf_index_path\nSAMPLE-1,pipelineA-callerA,false,path/to/vcf.gz,path/to/.vcf.gz.tbi\nSAMPLE-1,pipelineB-callerA,false,path/to/vcf.gz,path/to/.vcf.gz.tbi\nSAMPLE-2,pipelineB-callerB,true,path/to/g.vcf.gz,path/to/g.vcf.gz.tbi\nSAMPLE-2,pipelineB-callerB,true,path/to/g.vcf.gz,path/to/g.vcf.gz.tbi\n```\n\nEach row represents a VCF file coming from a sample. The `label` column enables concatenation of vcfs (for example when the pipeline produces different vcfs for chrM and chrY). The `gvcf` column indicates whether the file is a g.vcf file or not. The `vcf_path` and `vcf_index_path` columns contain the path to the VCF file and its index, respectively.\n\nNow, you can run the pipeline using:\n\n```bash\nnextflow run qbic-pipelines/vcftomat \\\n -profile <docker/singularity/.../institute> \\\n --input samplesheet.csv \\\n --genome GATK.GRCh38 \\\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**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n\n## Credits\n\nqbic-pipelines/vcftomat was originally written by Famke B\u00e4uerle, Dorothy Ellis.\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\n<!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. -->\n<!-- If you use qbic-pipelines/vcftomat for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->\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 uses 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/main/LICENSE).\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": [ | ||
| { | ||
| "@id": "main.nf" | ||
|
|
@@ -102,7 +102,7 @@ | |
| }, | ||
| "mentions": [ | ||
| { | ||
| "@id": "#ef3ff5d5-1a28-44fe-847e-e9a1ad90255a" | ||
| "@id": "#52a401c6-dec9-4dfe-92eb-d33149004223" | ||
| } | ||
| ], | ||
| "name": "qbic-pipelines/vcftomat" | ||
|
|
@@ -125,20 +125,33 @@ | |
| { | ||
| "@id": "main.nf", | ||
| "@type": ["File", "SoftwareSourceCode", "ComputationalWorkflow"], | ||
| "creator": [ | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-1387-0251" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]" | ||
| } | ||
| ], | ||
| "dateCreated": "", | ||
| "dateModified": "2024-12-18T14:49:24Z", | ||
| "dateModified": "2025-01-08T13:21:55Z", | ||
| "dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/", | ||
| "keywords": ["nf-core", "nextflow"], | ||
| "license": ["MIT"], | ||
| "maintainer": [ | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-1387-0251" | ||
| } | ||
| ], | ||
| "name": ["qbic-pipelines/vcftomat"], | ||
| "programmingLanguage": { | ||
| "@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow" | ||
| }, | ||
| "sdPublisher": { | ||
| "@id": "https://nf-co.re/" | ||
| }, | ||
| "url": ["https://github.com/qbic-pipelines/vcftomat", "https://nf-co.re/qbic-pipelines/vcftomat/dev/"], | ||
| "version": ["1.1.0dev"] | ||
| "url": ["https://github.com/qbic-pipelines/vcftomat", "https://nf-co.re/qbic-pipelines/vcftomat/1.1.0/"], | ||
| "version": ["1.1.0"] | ||
| }, | ||
| { | ||
| "@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow", | ||
|
|
@@ -153,11 +166,11 @@ | |
| "version": "!>=24.04.2" | ||
| }, | ||
| { | ||
| "@id": "#ef3ff5d5-1a28-44fe-847e-e9a1ad90255a", | ||
| "@id": "#52a401c6-dec9-4dfe-92eb-d33149004223", | ||
| "@type": "TestSuite", | ||
| "instance": [ | ||
| { | ||
| "@id": "#a59584b5-0a04-41cc-8552-686337cfb42a" | ||
| "@id": "#2a6b4982-255a-44b9-9ff1-e0690f6c6e9d" | ||
| } | ||
| ], | ||
| "mainEntity": { | ||
|
|
@@ -166,7 +179,7 @@ | |
| "name": "Test suite for qbic-pipelines/vcftomat" | ||
| }, | ||
| { | ||
| "@id": "#a59584b5-0a04-41cc-8552-686337cfb42a", | ||
| "@id": "#2a6b4982-255a-44b9-9ff1-e0690f6c6e9d", | ||
| "@type": "TestInstance", | ||
| "name": "GitHub Actions workflow for testing qbic-pipelines/vcftomat", | ||
| "resource": "repos/qbic-pipelines/vcftomat/actions/workflows/ci.yml", | ||
|
|
@@ -298,6 +311,18 @@ | |
| "@type": "Organization", | ||
| "name": "nf-core", | ||
| "url": "https://nf-co.re/" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-1387-0251", | ||
| "@type": "Person", | ||
| "email": "[email protected]", | ||
| "name": "Famke B\u00e4uerle" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]", | ||
| "@type": "Person", | ||
| "email": "[email protected]", | ||
| "name": "Famke Ba\u0308uerle" | ||
| } | ||
| ] | ||
| } | ||