iarcbioinfo/facets-nf

Sponsored OSS

By International Agency for Research on Cancer

Updated over 5 years ago

Docker for IARCBioinfo/facets-nf pipeline

Image
Languages & frameworks
Machine learning & AI
Data science
0

2.7K

iarcbioinfo/facets-nf repository overview

facets-nf

Pipeline using facets for fraction and copy number estimate from tumor/normal sequencing

UNDER DEVELOPMENT

CircleCI Docker Hub https://www.singularity-hub.org/static/img/hosted-singularity--hub-%23e32929.svg DOI

Workflow representation

Description

...

Dependencies

  1. This pipeline is based on nextflow. As we have several nextflow pipelines, we have centralized the common information in the IARC-nf repository. Please read it carefully as it contains essential information for the installation, basic usage and configuration of nextflow and our pipelines.
  2. External software:

You can avoid installing all the external software by only installing Docker. See the IARC-nf repository for more information.

Input (mandatory)

TypeDescription
--tumor_bam_folderFolder containing tumor BAM files
--normal_bam_folderFolder containing normal BAM files
OR
--bam_folderFolder containing all BAM files (without "/" at the end)
--tn_fileFile containing the list of names of BAM files to be processed - by pairs T/N (tab-delimited as follow: T.bam, N.bam)

Parameters

NameExample valueDescription
--refhg19/hg38Version of genome: hg19 or hg38
--dbsnp_vcf_refref/dbsnp_vcf_refPath to dbsnp vcf reference

Dbsnp vcf reference can be downloaded for:

  • hg19: wget ftp://ftp.ncbi.nlm.nih.gov/snp/organisms/human_9606_b150_GRCh37p13/VCF/00-common_all.vcf.gz

  • hg38: wget ftp://ftp.ncbi.nlm.nih.gov/snp/organisms/human_9606_b150_GRCh38p7/VCF/00-common_all.vcf.gz

NameDefault valueDescription
--mem4 GBmemory allocated to each nextflow process
--snppileup_binsnp-pileupPath to snppileup software (default: snp-pileup)
--analysis_typegenome/exomeType of analysis: whole genome (by default) or whole exome - sets next five parameters values
--snp_nbhd1000 or 2501st value for genome, 2nd value for exome analysis
--cval_preproc35 por 251st value for genome, 2nd value for exome analysis
--cval_proc1300 or 1501st value for genome, 2nd value for exome analysis
--cval_proc2150 or 751st value for genome, 2nd value for exome analysis
--min_read_count20 or 351st value for genome, 2nd value for exome analysis
--suffix_tumor"_T"specific suffix for tumor bam file name
--suffix_normal"_N"specific suffix for normal bam file name
--min-map-quality15
--min-base-quality20
--pseudo-snps100
--facets_stats_outfacets_stats_summary.txtName of stats summary file
--out_folderfacets_outFolder name for output files (by default current folder)

Flags are special parameters without value.

NameDescription
--helpDisplay help
--output_pdfProgram outputs a (large) pdf instead of png

Usage

nextflow run iarcbioinfo/facets-nf --tumor_bam_folder path/to/T_BAMS --normal_bam_folder path/to/N_BAMS --analysis_type genome --ref hg38 --dbsnp_vcf_ref path/to/dbSNP_vcf_ref.vcf.gz 

Output

TypeDescription
All_stats.txtStats for all samples pooled
Sample_CNV.txtA few stats for the sample
Sample_CNV_spider.txtspider plot for parameter estimates
Sample_CNV.png or Sample_CNV.pdfoutput plot of CNV
Sample.RDataR object with 5 objects (xx,oo_large,fit_large,oo_fine,fit_fine)

In Sample.RData:

  • xx corresponds to the pre-processed data using the segmentation critical value cval_preproc (output of function preProcSample)

  • oo_large corresponds to the processing of xx using the segmentation critical value cval_proc1 (output of function procSample(xx,cval = cval_proc1,...) )

  • fit_large: cluster specific copy number and cellular fraction (output of emcncf(oo_large))

  • oo_fine corresponds to the processing of xx using the segmentation critical value cval_proc2 (output of procSample(xx, cval = cval_proc2, ...))

  • fit_fine: cluster specific copy number and cellular fraction ( output of emcncf(oo_fine))

Common errors

In case of low coverage you may get the following error during facets process:

Loading required package: pctGCdata
Error in fit.cpt.tree(genomdat, cval = cval, hscl = hscl, delta = delta) :
NA/NaN/Inf in foreign function call (arg 9)
Calls: preProcSample -> segsnps -> fit.cpt.tree

=> We advise then to decrease the parameter: min_read_count

Directed Acyclic Graph

DAG

Contributions

NameEmailDescription
Matthieu Foll*[email protected]Developer to contact for support (link to specific gitter chatroom)
Catherine Voegele[email protected]Developer
Nicolas Alcala[email protected]Developer

Tag summary

Content type

Image

Digest

Size

604.2 MB

Last updated

over 5 years ago

docker pull iarcbioinfo/facets-nf:v2.0

This week's pulls

Pulls:

259

Last week