deepcsa

Pipeline for the analysis of the clonal structure of tissues. It takes advantage of the availability of information about the sequencing depth.

https://github.com/bbglab/deepcsa

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 (15.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Pipeline for the analysis of the clonal structure of tissues. It takes advantage of the availability of information about the sequencing depth.

Basic Info
  • Host: GitHub
  • Owner: bbglab
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 3.61 MB
Statistics
  • Stars: 1
  • Watchers: 4
  • Forks: 0
  • Open Issues: 130
  • Releases: 2
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

deepCSA

Introduction

bbglab/deepCSA is a bioinformatics pipeline that can be used for analyzing the clonal structure information from targeted DNA sequencing data. It was designed for duplex sequencing data of normal tissues.

deepCSA workflow overview

Usage

First, prepare a samplesheet with your input data that looks as follows:

samplesheet.csv:

csv sample,vcf,bam sample1,sample1.high.filtered.vcf,sample1.sorted.bam sample2,sample2.high.filtered.vcf,sample2.sorted.bam

Each row represents a single sample with a single-sample VCF containing the mutations called in that sample and the BAM file that was used for getting those variant calls. The mutations will be obtained from the VCF and the BAM file will be used for computing the sequencing depth at each position and using this for the downstream analysis.

Make sure that you do not use any '.' in your sample names, and also use text-like names for the samples, try to avoid having only numbers. This second case should be handled properly but using string-like names will ensure consistency.

There are specific datasets that need to be prepared before running deepCSA. You can find a list of those, and instructions for downloading them in the documentation section of the repo.

After making sure that these files are ready, you can now run the pipeline using:

bash git clone https://github.com/bbglab/deepCSA.git cd deepCSA nextflow run main.nf --outdir <OUTDIR> -profile singularity,<DESIRED PROFILE> -params-file pipeline_params.yml

The input can be provided by the --input option but it is more recommended to define this and all the other parameters in a parameter file (i.e. pipeline_params.yml), that can be provided to the pipeline for running the analysis with the specified configuration. This will also allow the definition of the remaining required parameters.

Warning

Please provide pipeline parameters via the Nextflow -params-file option or CLI. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters_; see docs.

Credits

bbglab/deepCSA was originally written by Ferriol Calvet.

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

  • @rblancomi
  • @FedericaBrando
  • @koszulordie
  • @St3451
  • @AxelRosendahlHuber
  • @andrianovam
  • @migrau

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.

Documentation

Find the documentation (link to docs).

Owner

  • Name: BBGLab - Barcelona Biomedical Genomics Lab
  • Login: bbglab
  • Kind: organization
  • Email: bbglab@irbbarcelona.org
  • Location: Barcelona

Citation (CITATIONS.md)

# bbglab/deepCSA: 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].

- [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)

  > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. 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
  • Issues event: 35
  • Delete event: 10
  • Issue comment event: 33
  • Push event: 51
  • Pull request review comment event: 23
  • Pull request review event: 17
  • Pull request event: 21
  • Create event: 6
Last Year
  • Issues event: 35
  • Delete event: 10
  • Issue comment event: 33
  • Push event: 51
  • Pull request review comment event: 23
  • Pull request review event: 17
  • Pull request event: 21
  • Create event: 6

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 28
  • Total pull requests: 11
  • Average time to close issues: 9 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.55
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 23
  • Pull requests: 10
  • Average time to close issues: 3 months
  • Average time to close pull requests: 4 days
  • Issue authors: 4
  • Pull request authors: 2
  • Average comments per issue: 0.26
  • Average comments per pull request: 0.5
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • FerriolCalvet (20)
  • bkohrn (5)
  • efigb (2)
  • rochamorro1 (1)
Pull Request Authors
  • FerriolCalvet (10)
  • koszulordie (1)
Top Labels
Issue Labels
documentation (1) enhancement (1) bug (1) discuss (1) new-feature (1) output-related (1) plot (1) on-hold (1) Low (1) code-review :woman_technologist: (1) add-params (1)
Pull Request Labels
enhancement (1) Medium (1) on-hold (1)

Dependencies

modules/local/annotatedepth/meta.yml cpan
modules/local/bbgtools/omega/estimator/meta.yml cpan
modules/local/bbgtools/omega/mutabilities/meta.yml cpan
modules/local/bbgtools/omega/preprocess/meta.yml cpan
modules/local/bbgtools/oncodrive3d/plot/meta.yml cpan
modules/local/bbgtools/oncodrive3d/plot_chimerax/meta.yml cpan
modules/local/bbgtools/oncodrive3d/preprocessing/meta.yml cpan
modules/local/bbgtools/oncodrive3d/run/meta.yml cpan
modules/local/bbgtools/oncodriveclustl/meta.yml cpan
modules/local/bbgtools/oncodrivefml/meta.yml cpan
modules/local/bbgtools/sitecomparison/meta.yml cpan
modules/local/combine_sbs/meta.yml cpan
modules/local/compute_mutability/meta.yml cpan
modules/local/compute_profile/meta.yml cpan
modules/local/compute_trinucleotide/meta.yml cpan
modules/local/computedepths/meta.yml cpan
modules/local/dnds/preprocess/meta.yml cpan
modules/local/dnds/run/meta.yml cpan
modules/local/downsample/depths/meta.yml cpan
modules/local/downsample/mutations/meta.yml cpan
modules/local/expand_regions/meta.yml cpan
modules/local/filterbed/meta.yml cpan
modules/local/filtermaf/meta.yml cpan
modules/local/group_genes/meta.yml cpan
modules/local/indels/meta.yml cpan
modules/local/mergemafs/meta.yml cpan
modules/local/mutation_matrix/meta.yml cpan
modules/local/mutations2sbs/meta.yml cpan
modules/local/plot/mutations_summary/meta.yml cpan
modules/local/plot/needles/meta.yml cpan
modules/local/plot/omega/meta.yml cpan
modules/local/plot/selection_metrics/meta.yml cpan
modules/local/process_annotation/domain/meta.yml cpan
modules/local/process_annotation/mutations/meta.yml cpan
modules/local/process_annotation/mutations_custom/meta.yml cpan
modules/local/process_annotation/panel/meta.yml cpan
modules/local/process_annotation/panelcustom/meta.yml cpan
modules/local/runregressions/meta.yml cpan
modules/local/sig_matrix_concat/meta.yml cpan
modules/local/sitesfrompositions/meta.yml cpan
modules/local/subsetmaf/meta.yml cpan
modules/local/table2groups/meta.yml cpan
modules/local/vcf2maf/meta.yml cpan
modules/local/writemaf/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/ensemblvep/download/meta.yml cpan
modules/nf-core/ensemblvep/vep/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/tabix/bgziptabix/meta.yml cpan
modules/nf-core/tabix/bgziptabixquery/meta.yml cpan
subworkflows/local/createpanels/meta.yml cpan
subworkflows/local/depthanalysis/meta.yml cpan
subworkflows/local/dnds/meta.yml cpan
subworkflows/local/indels/meta.yml cpan
subworkflows/local/mutability/meta.yml cpan
subworkflows/local/mutatedcells/expected/meta.yml cpan
subworkflows/local/mutatedcells/vaf/meta.yml cpan
subworkflows/local/mutationpreprocessing/meta.yml cpan
subworkflows/local/mutationprofile/meta.yml cpan
subworkflows/local/mutationrate/meta.yml cpan
subworkflows/local/omega/meta.yml cpan
subworkflows/local/oncodrive3d/meta.yml cpan
subworkflows/local/oncodriveclustl/meta.yml cpan
subworkflows/local/oncodrivefml/meta.yml cpan
subworkflows/local/plotdepths/meta.yml cpan
subworkflows/local/regressions/meta.yml cpan
subworkflows/local/signatures/meta.yml cpan
subworkflows/nf-core/utils_nextflow_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfcore_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfvalidation_plugin/meta.yml cpan
modules/local/computedepths/environment.yml pypi
modules/nf-core/tabix/bgziptabix/environment.yml pypi
modules/nf-core/tabix/bgziptabixquery/environment.yml pypi
pyproject.toml pypi