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.
Most large structural variants in cancer genomes can be detected without long reads. Choo, ZN., Behr, J.M., Deshpande, A. et al.
Nat Genet 2023 Nov 09. doi: https://doi.org/10.1038/s41588-023-01540-6
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.
mskilab-org/nf-JaBbA is a new state-of-the-art bioinformatics pipeline from mskilab-org for running JaBbA, our algorithm for doing MIP based joint inference of copy number and rearrangement state in cancer whole genome sequence data. This pipeline runs all the pre-requisite modules and generates the necessary inputs for running JaBbA. It is designed to take tumor-normal pairs of human samples as input.
We took inspiration from nf-core/Sarek, a workflow for detecting variants in whole genome or targeted sequencing data. nf-jabba is built using Nextflow and the Nextflow DSL2. All the modules use Docker and Singularity containers, for easy execution and reproducibility. Some of the modules/processes are derived from open source nf-core/modules.
This pipeline has been designed to start from FASTQ files or directly from BAM files. Paths to these files should be supplied in a CSV file (please refer to the section below for the input format of the .csv file).
- Alignment to Reference Genome (currently supports
BWA-MEM&BWA-MEM2; a modified version of theAlignmentstep fromnf-core/Sarekis used here). ) - Quality Control (using
FastQC) - Trimming (must turn on using
--trim_fastq) (usingfastp) - Marking Duplicates (using
GATK MarkDuplicates) - Base recalibration (using
GATK BaseRecalibrator) - Applying BQSR (using
GATK ApplyBQSR) - Performing structural variant calling (using
SVABAand/orGRIDSS; must mention using--tools) - Perform pileups (using mskilab's custom
HetPileupsmodule; must mention using--tools) - Generate raw coverages and correct for GC & Mappability bias (using
fragCounter; must mention using--tools) - Remove biological and technical noise from coverage data. (using
Dryclean; must mention using--tools) - Perform segmentation using tumor/normal ratios of corrected read counts, (using the
CBS(circular binary segmentation) algorithm; must mention using--tools) - Purity & ploidy estimation (currently supports
ASCATto pass ploidy values to JaBbA; must mention using--tools) - Execute JaBbA (using inputs from
Dryclean,CBS,HetPileupsand/orASCAT; must mention using--tools)
Note If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with
-profile testbefore running the workflow on actual data.
You need to create a samplesheet with information regarding the samples you want to run the pipeline on. You need to specify the path of your samplesheet using the --input flag to specify the location. Make sure the input file is a comma-separated file and contains the headers discussed below. It is highly recommended to provide the absolute path for inputs inside the samplesheet rather than relative paths.
To mention a sample as paired tumor-normal, it has to be specified with the same patient ID, a different sample, and their respective status. A 1 in the status field indicates a tumor sample, while a 0 indicates a normal sample. If there are multiple sample IDs, nf-jabba will consider them as separate samples and output the results in separate folders based on the patient attribute. All the runs will be separated by patient, to ensure that there is no mixing of outputs.
You need to specify the desired output root directory using --outdir flag. The outputs will then be stored in your designated folder, organized by tool and sample.
To run the pipeline from the beginning, first create an --input sampleSheet.csv file with your file paths. A typical input whould look like this:
patient,sex,status,sample,lane,fastq_1,fastq_2
TCXX49,XX,0,TCXX49_N,lane_1,/path/to/fastq_1.fq.gz,/path/to/fastq_2.gz
Each row represents a pair of fastq files (paired end) for each sample. After the input file is ready, you can run the pipeline using:
nextflow run mskilab-org/nf-jabba \
-profile <docker/singularity/.../institute> \
--input samplesheet.csv \
--outdir <OUTDIR> \
--tools <svaba,fragcounter,dryclean,cbs,hetpileups,ascat,jabba> \
--genome <GATK.GRCh37/GATK.GRCh38>Warning: Please provide pipeline parameters via the CLI or Nextflow
-params-fileoption. Custom config files including those provided by the-cNextflow option can be used to provide any configuration except for parameters; see docs.
A typical sample sheet should populate with the column names as shown below:
| Column Name | Description |
|---|---|
| patient | Patient or Sample ID. This should differentiate each patient/sample. Note: Each patient can have multiple sample names. |
| sample | Sample ID for each Patient. Should differentiate between tumor and normal. Sample IDs should be unique to Patient IDs |
| lane | If starting with FASTQ files, and if there are multiple lanes for each sample for each patient, mention lane name. **Required for --step alignment. |
| sex | If known, please provide the sex for the patient. For instance if Male type XY, else if Female type XX, otherwise put NA. |
| status | This should indicate if your sample is tumor or normal. For normal, write 0, and for tumor, write 1. |
| fastq_1 | Full Path to FASTQ file read 1. The extension should be .fastq.gz or .fq.gz. Required for --step alignment. |
| fastq_2 | Full Path to FASTQ file read 2. The extension should be .fastq.gz or .fq.gz. Required for --step alignment. |
| bam | Full Path to BAM file. The extension should be .bam. Required for --step sv_calling. |
| bai | Full Path to BAM index file. The extension should be .bam.bai. Required for --step sv_calling. |
| cram | Full Path to CRAM file. The extension should be .cram. Required for --step sv_calling if file is of type CRAM. |
| crai | Full Path to CRAM index file. The extension should be .cram.crai. Required for --step sv_calling if file is of type CRAM. |
| table | Full path to Recalibration table file. Required for --step recalibrate. |
| vcf | Full path to VCF file. Required for --step jabba. |
| hets | Full path to HetPileups .txt file. Required for --step jabba. |
For more information regarding the pipeline usage and the inputs necesaary for each step, please follow the Usage documentation.
If a process of the pipeline fails or is interrupted at some point, Nextflow can resume from that point without having to start over from the beginning. You must specify this in the CLI or on the command-line when restarting a pipeline. You can also supply a run name to resume a specific run using: -resume [run-name]. Use the nextflow log command to show previous run names.
Use this parameter for choosing a configuration profile. Profiles contain configuration presets for different computing environments.
Several generic profiles have been provided by default which instruct the pipeline to use software packaged using different methods. You can use this option to run the pipeline via containers (singularity/Docker) (highly recommended)
You can mention custom configuration scripts to run the pipeline with using the -c flag and providing a path to the .config file. This is advised when you want to submit processes into an executor like slurm or LSF.
The Nextflow -bg flag launches the Nextflow pipeline as a background process. This allows you to detach or exit your terminal without interrupting the run. A log of the run will be saved inside a file upon completion. You can also use screen or tmux sessions to persist runs.
Every module in the pipeline has been containerized. Some modules are partially modified versions of nf-core/modules, these modules use nf-core containers. Modules that use our lab packages and scripts were containerized into Docker images. These images can be found on our DockerHub.
Warning: JaBbA depends on CPLEX MIP Optimizer to work. Because CPLEX is a proprietary software, it isn't included in the image and needs to be installed by the user. To add CPLEX:
- Download CPLEX (Linux x86-64). (You may need to use the HTTP method.)
- Pull image and run the container using:
docker pull mskilab/jabba:latest docker run -it --rm --platform linux/amd64 mskilab/jabba:latest
- Copy CPLEX binary into the container: docker cp /PATH/TO/DOWNLOADED_CPLEX.bin CONTAINER_ID:/opt/cplex_studio
- Install CPLEX: /opt/cplex_studio/DOWNLOADED_CPLEX.bin (If you get a Permission denied error, run chmod 777 /PATH/TO/DOWNLOADED_CPLEX.bin before copying it into the container.)
- When prompted for an installation path, type /opt/cplex. This is what the CPLEX_DIR environmental variable is set to.
- Save changes to a new image for future use: Exit container (type exit or press Ctrl-D) Run docker commit CONTAINER_ID NEW_IMAGE_ID
To debug any step or process that failed, first check your current execution_trace*.txt file inside the <outdir>/pipeline_info/ folder. There you'll find a hash number for that process. You can use that hash number to locate that process's working directory. This directory will contain multiple .command.* files that correspond to your run and contain valuable information that can help you debug your error. You can also run the .command.sh script to do a manual, isolated execution of the offending process for quick testing.
nf-jabba was written by Tanubrata Dey and Shihab Dider at the Perlmutter Cancer Center and the New York Genome Center.
We thank the following people for their extensive guidance in the development of this pipeline:
If you would like to contribute to this pipeline, please see the contributing guidelines.