Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

lp-wgs

Basic Info
  • Host: GitHub
  • Owner: chelauk
  • License: mit
  • Language: Nextflow
  • Default Branch: main
  • Size: 2.39 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Introduction

lp-wgs is a bioinformatics analysis pipeline for shallow whole genome sequence analyses.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules

Pipeline summary

  1. Read QC (FastQC)
  2. Trim Reads (Fastp)
  3. Align Reads (bwa) (optional: begin from this stage)
  4. Filter Bam (samtools) (optional: if it is set with --filter-bam the default is 90<=fragment size<=150, this can be set with --filterbammin and --filterbammax)
  5. Coverage (mosdepth)
  6. Alignment QC with (picard)
  7. GC counts (HMMcopy)
  8. read counts (HMMcopy)
  9. ICHOR cna calls and tumour cell fraction (ICHOR)
  10. Segmentation and log read ratios QDNAseq (QDNAseq)
  11. ACE cna calls and tumour cell fraction (ACE)

Bin options for ICHOR include 1000kb,500kb,100kb and 10kb these are set with the --map_bin parameter for ichor the normal fraction and ploids and subclone fractions can be set, see here for low tumour fractions setting

   --ichor_purity cf_dna
  • will set these parameters for ichor automatically

    --normal "c(0.95, 0.99, 0.995, 0.999)"  
    --ploidy "c(2)"  
    --maxCN 3  
    --estimateScPrevalence FALSE   
    --scStates "c()"   
    --chrs "c(1:22)"   
    --chrTrain "c(1:22)" 
    
  • otherwise you can set

    --ichorpuritymanual c(0.95, 0.99, 0.995, 0.999) which will set this parameter for ichor

    --normal "c(0.95, 0.99, 0.995, 0.999)"

  1. ACE Absolute Copy number Estimation using low-coverage whole genome sequencing data (ACE). The default script for ACE is ``` library(ACE) args <- commandArgs(trailingOnly = TRUE) output_folder <- args[1] ploidy <- c(2, 3, 4)

runACE( outputdir = output_folder, filetype = "bam", genome = "hg38", ploidies = ploidy ) `` 10. Collate QC ([MultiQC`](http://multiqc.info/))

mermaid flowchart TD step1(reference fasta) step2(fastqs) step2-->step3(qc fastqc) step2-->step4(trim fastp) step1-->step5(align bwa) step4-->step5(align bwa) step5-->step6(coverage mosdepth) step5-->step7(alignment qc picard) step1-->step13(gccounter HMMCOPY) step5-->step8(counter HMMCOPY) step13-->step9(CNA ICHOR) step8-->step9(CNA ICHOR) step5-->step10(DNA ACE) step10-->step11(copy number output) step9-->step11(copy number output) step3-->step12(multiqc) step6-->step12(multiqc)

slurm quick start:

The pipeline will require a csv file with headers describing the paths to samples

  1. Starting from fastq example csv: patient,sample,lane,fastq_1,fastq_2 patient1,sample1,1,./data/patient1_sample1_R1.fastq.gz,./data/patient1_sample1_R2.fastq.gz patient1,sample2,1,./data/patient1_sample2_R1.fastq.gz,./data/patient1_sample2_R2.fastq.gz patient2,sample1,1,./data/patient2_sample1_R1.fastq.gz,./data/patient2_sample1_R2.fastq.gz patient2,sample2,1,./data/patient2_sample2_R1.fastq.gz,./data/patient2_sample2_R2.fastq.gz Multi-lane samples are merged automatically with sambamba

example sbatch script: ```

!/bin/bash -l

SBATCH --job-name=nextflow

SBATCH --output=nextflow_out.txt

SBATCH --partition=master-worker

SBATCH --ntasks=1

SBATCH --time=96:00:00

module load java/jdk15.0.1 nextflow run /path/to/lp-wgs \ --input inputfastq.csv \ --outdir results \ --igenomesbase /path/to/reference \ --step 'fastq' \ -c local.config \ -with-tower \ -profile singularity \ -resume `` note that when starting with fastq you need to add--step fastq`

note with regard to the reference path it needs to match this pattern: bwa = "${params.igenomes_base}/Homo_sapiens/GATK/GRCh38/Sequence/BWAIndex/" dict = "${params.igenomes_base}/Homo_sapiens/GATK/GRCh38/Sequence/WholeGenomeFasta/Homo_sapiens_assembly38.dict" fasta = "${params.igenomes_base}/Homo_sapiens/GATK/GRCh38/Sequence/WholeGenomeFasta/Homo_sapiens_assembly38.fasta" fasta_fai = "${params.igenomes_base}/Homo_sapiens/GATK/GRCh38/Sequence/WholeGenomeFasta/Homo_sapiens_assembly38.fasta.fai" or you can modify the genomes.config file yourself

  1. Starting from bam example csv: patient,sample,fastq_1 ,fastq_2 patient1,sample1,./data/patient1_sample1.bam patient1,sample2,./data/patient1_sample2.bam patient2,sample1,./data/patient2_sample1.bam patient2,sample2,./data/patient2_sample2.bam example sbatch script: ``` #!/bin/bash -l #SBATCH --job-name=nextflow #SBATCH --output=nextflow_out.txt #SBATCH --partition=master-worker #SBATCH --ntasks=1 #SBATCH --time=96:00:00

module load java/jdk15.0.1 nextflow run /path/to/lp-wgs \ --input inputfastq.csv \ --outdir results \ --igenomesbase /path/to/reference \ --step 'bam' \ -c local.config \ -with-tower \ -profile singularity \ -resume ```

Note that some form of configuration will be needed so that Nextflow knows how to fetch the required software. This is usually done in the form of a config profile (YOURPROFILE in the example command above). You can chain multiple config profiles in a comma-separated string.

  • The pipeline comes with config profiles called docker, singularity, podman, shifter, charliecloud and conda which instruct the pipeline to use the named tool for software management. For example, -profile test,docker.
  • 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.
  • If you are using singularity, please use the nf-core download command to download images first, before running the pipeline. Setting the NXF_SINGULARITY_CACHEDIR or singularity.cacheDir Nextflow options enables you to store and re-use the images from a central location for future pipeline runs.
  • If you are using conda, it is highly recommended to use the NXF_CONDA_CACHEDIR or conda.cacheDir settings to store the environments in a central location for future pipeline runs.
  1. Start running your own analysis!

nextflow run lp-wgs --input samplesheet.csv --outdir --genome GRCh38 -profile ```

Credits

lp-wgs was originally written by Chela James George Cresswell.

We thank the following people for their extensive assistance in the development of this pipeline:

Contributions and Support

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

Citations

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

Owner

  • Name: Chela James
  • Login: chelauk
  • Kind: user
  • Location: Milan
  • Company: Fondazione Human Technopole

Senior Bioinformatician Fondazione Human Technopole

Citation (CITATIONS.md)

# lp-wgs: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)
  > Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].24 Jun 2015

- [fastp](https://github.com/OpenGene/fastp)
  > Shifu Chen, Yanqing Zhou, Yaru Chen, Jia Gu; fastp: an ultra-fast all-in-one FASTQ preprocessor. Bioinformatics, Volume 34, Issue 17, 1 September 2018, Pages i884–i890, https://doi.org/10.1093/bioinformatics/bty560

- [mosdepth](https://github.com/brentp/mosdepth)
  > Brent S Pedersen, Aaron R Quinlan. Mosdepth: quick coverage calculation for genomes and exomes. Bioinformatics, Volume 34, Issue 5, March 2018, Pages 867–868, https://doi.org/10.1093/bioinformatics/btx699

- [bwa](https://github.com/lh3/bwa)
  > Li H. (2013) Aligning sequence reads, clone sequences and assembly contigs with BWA-MEM. arXiv:1303.3997v2 [q-bio.GN].

- [ACE](https://github.com/tgac-vumc/ACE)
  > Poell JB, Mendeville M, Sie D, Brink A, Brakenhoff RH, Ylstra B.  ACE: Absolute Copy number Estimation from low-coverage whole-genome sequencing data.  Bioinformatics. 2018 Dec 28. doi: 10.1093/bioinformatics/bty1055

- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)
  > Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
  • Delete event: 1
  • Push event: 25
  • Create event: 2
Last Year
  • Delete event: 1
  • Push event: 25
  • Create event: 2

Dependencies

modules/local/picard/collectalignmentmummarymetrics/meta.yml cpan
modules/local/sambamba/merge/meta.yml cpan
modules/nf-core/bwa/mem/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/fastp/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/hmmcopy/gccounter/meta.yml cpan
modules/nf-core/hmmcopy/readcounter/meta.yml cpan
modules/nf-core/ichorcna/run/meta.yml cpan
modules/nf-core/mosdepth/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/picard/collectinsertsizemetrics/meta.yml cpan
modules/nf-core/sambamba/markdup/meta.yml cpan
modules/nf-core/samtools/view/meta.yml cpan
pyproject.toml pypi