Conversation
PR checklist
|
|
There was a problem hiding this comment.
Moved PR link to the beginning of the line as I think it makes it easier to read when rendered. Thoughts?
| <!-- 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. --> | ||
| <!-- If you use Clinical-Genomics/oncorefiner for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) --> |
There was a problem hiding this comment.
This is to be updated after the first release!
| <!-- 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. --> | ||
| <!-- If you use Clinical-Genomics/oncorefiner for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) --> | ||
|
|
||
| <!-- TODO nf-core: Add bibliography of tools and data used in your pipeline --> |
There was a problem hiding this comment.
Added to CITATIONS.md which is mentioned in the next line.
If we use additional data in the pipeline in the future, we should document that here.
| nextflow run Clinical-Genomics/oncorefiner \ | ||
| -profile <docker/singularity/.../institute> \ | ||
| --input samplesheet.csv \ | ||
| --outdir <OUTDIR> |
There was a problem hiding this comment.
Are there any other parameters required for a minimal run? See comment above.
| 1. Process SNV VCF files | ||
| 1. Annotate with [`Vcfanno`](https://github.com/brentp/vcfanno) | ||
| 1. Filter according to call quality with [`bcftools`](https://github.com/samtools/bcftools) | ||
| 1. Filter according to user provided list of research relevant variant with [`bcftools`](https://github.com/samtools/bcftools) | ||
| 1. Annotate with [`VEP`](https://www.ensembl.org/info/docs/tools/vep/index.html) | ||
| 1. Filter according to user provided list of clinically relevant variants with [`bcftools`](https://github.com/samtools/bcftools) | ||
|
|
||
| 1. Process SV VCF files | ||
| 1. SVDB QUERY ??? | ||
| 1. Filter according to call quality with ??? | ||
| 1. Filter according to user provided list of research relevant variant with [`bcftools`](https://github.com/samtools/bcftools) | ||
| 1. Annotate with [`VEP`](https://www.ensembl.org/info/docs/tools/vep/index.html) | ||
| 1. Filter according to user provided list of clinically relevant variants with [`bcftools`](https://github.com/samtools/bcftools) | ||
|
|
||
| 1. Present QC for raw reads ([`MultiQC`](http://multiqc.info/)) |
There was a problem hiding this comment.
Can you check this information and fill in the missing parts marked with ????
| ## Introduction | ||
|
|
||
| **Clinical-Genomics/oncorefiner** is a bioinformatics pipeline that ... | ||
| **Clinical-Genomics/oncorefiner** is a customizable post-processing and extension layer for Oncoanalyser that adapts its outputs according to clinical and operational needs, adds missing analyses, and ensures flexibility for evolving standards while retaining Oncoanalyser's robust core. |
There was a problem hiding this comment.
Added the same text that is in .nf-core.yml. We could provide a bit more information about the processes and the output when the issues mentioned above are cleared out.
|
|
||
| <!-- TODO nf-core: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website. --> | ||
|
|
||
| ## Samplesheet input |
There was a problem hiding this comment.
This information is general for the use of samplesheets. For oncorefiner, this will change when we decide on an input file strategy in https://github.com/Clinical-Genomics/CancerBioInfo/issues/101. Same for usage information in README.md. Added that as acceptance criterion for the issue.
Do you want to include the input VCF file parameters here already or should we leave this for when we figure things out in the issue above?
There was a problem hiding this comment.
All of this would be changed once the issue to Clean up pipeline output structure and file naming is cleared out. I think we should wait to write this until after that and keep what is here as a placeholder for now. I have included updating the documentation as an acceptance criterion for the issue above.
There was a problem hiding this comment.
This is not present in the acceptance criteria or PR description since I wanted to hear your opinions first!
I thought it would be nice to add a link to the contributing guidelines when you are about to create an issue. What do you think? 🙂
|
|
||
| 1. Process SNV VCF files | ||
| 1. Annotate with [`Vcfanno`](https://github.com/brentp/vcfanno) | ||
| 1. Filter according to call quality with [`bcftools`](https://github.com/samtools/bcftools) | ||
| 1. Filter according to user provided list of research relevant variant with [`bcftools`](https://github.com/samtools/bcftools) | ||
| 1. Annotate with [`Ensembl VEP`](https://www.ensembl.org/info/docs/tools/vep/index.html) | ||
| 1. Filter according to user provided list of clinically relevant variants with [`bcftools`](https://github.com/samtools/bcftools) | ||
|
|
||
| 1. Process SV VCF files | ||
| 1. SVDB QUERY ??? | ||
| 1. Filter according to call quality with ??? | ||
| 1. Filter according to user provided list of research relevant variant with [`bcftools`](https://github.com/samtools/bcftools) | ||
| 1. Annotate with [`Ensembl VEP`](https://www.ensembl.org/info/docs/tools/vep/index.html) | ||
| 1. Filter according to user provided list of clinically relevant variants with [`bcftools`](https://github.com/samtools/bcftools) | ||
|
|
||
| 1. Present QC for raw reads ([`MultiQC`](http://multiqc.info/)) | ||
|
|
||
| ### Summary of tools and version used in the pipeline | ||
|
|
||
| | Step | Tool | Version | | ||
| | --------------------- | ------------- | ------- | | ||
| | Clinical Filtering | bcftools | 1.22 | | ||
| | Clinical Filtering SV | bcftools | 1.22 | | ||
| | EnsemblVEP SNV | ensemblvep | 115.2 | | ||
| | EnsemblVEP SNV | perl-math-cdf | 0.1 | | ||
| | EnsemblVEP SNV | tabix | 1.21 | | ||
| | EnsemblVEP SV | ensemblvep | 115.2 | | ||
| | EnsemblVEP SV | perl-math-cdf | 0.1 | | ||
| | EnsemblVEP SV | tabix | 1.21 | | ||
| | Research Filtering | bcftools | 1.22 | | ||
| | Research Filtering SV | bcftools | 1.22 | | ||
| | SVDB Query DB | svdb | 2.8.4 | | ||
| | Untar VEP Cache | untar | 1.34 | | ||
| | Vcfanno | vcfanno | 0.3.7 | |
There was a problem hiding this comment.
Another option for the structure of this section is following what /nf-core/raredisease did!
But perhaps the versions are still relevant to include? You can always see them in the pipeline_info/*versions.yml but it can be nice to have it written here and not have to run the pipeline to get it.
There was a problem hiding this comment.
I think we should adopt a lot of things from the raredisease contributing guidelines!
Thoughts?
This will give us more merge conflicts when the template is updated, but I think it's worth it since it's very important information.
Closes #28.
Changed
.github/CONTRIBUTING.mdto the list of files for lint ignore since it no longer follows the nf-core template.Fixed
.nf-core.yml.parameters.mdby running pre-commit.CHANGELOG.md..github/CONTRIBUTING.md:README.md:Usagesection.CITATIONS.md.docs/usage.md. Input information will be updated when the input file structure is decided.docs/output.mdwith an example. To be expanded when output file structure is decided.