:wrench: This pipeline is currently under development :wrench:
- User guide
- Workflow summaries
- Additional notes
GermlineStructuralV-nf is a pipeline for identifying structural variant events in human Illumina short read whole genome sequence data. GermlineStructuralV-nf identifies structural variant and copy number events from BAM files using Manta, Smoove, and TIDDIT. Variants are then merged using SURVIVOR, and annotated by AnnotSV. The pipeline is written in Nextflow and uses Singularity/Docker to run containerised tools.
Structural and copy number detection is challenging. Most structural variant detection tools infer these events from read mapping patterns, which can often resemble sequencing and read alignment artefacts. To address this, GermlineStructuralV-nf employs 3 general purpose structural variant calling tools, which each support a combination of detection methods. Manta, Smoove and TIDDIT use typical detection approaches that consider:
- Discordant read pair alignments
- Split reads that span a breakpoints
- Read depth profiling
- Local de novo assembly
This approach is currently considered the best approach for maximising sensitivty of short read data (Cameron et al. 2019, Malmoud et al. 2019). By using a combination of tools that employ different methods, we improve our ability to detect different types and sizes of variant events.
To run this pipeline, you will need to prepare your input files, reference data, and clone this repository. Before proceeding, ensure Nextflow is installed on the system you're working on. To install Nextflow, see these instructions.
1. Prepare inputs
To run this pipeline you will need the following inputs:
- Paired-end BAM files
- Corresponding BAM index files
- Input sample sheet
This pipeline processes paired-end BAM files and is capable of processing multiple samples in parallel. BAM files are expected to be coordinate sorted and indexed (see Fastq-to-BAM for an example of a best practice workflow that can generate these files).
You will need to create a sample sheet with information about the samples you are processing, before running the pipeline. This file must be tab-separated and contain a header and one row per sample. Columns should correspond to sampleID, BAM file, BAI file:
When you run the pipeline, you will use the mandatory
--input parameter to specify the location and name of the input file:
2. Prepare the reference materials
To run this pipeline you will need the following reference files:
- Indexed reference genome in FASTA format
- AnnotSV annotation datasets (Optional)
You will need to download and index a copy of the reference genome you would like to use. Reference FASTA files must be accompanied by a .fai index file. If you are working with a species that has a public reference genome, you can download FASTA files from the Ensembl, UCSC, or NCBI ftp sites. You can use the IndexReferenceFasta-nf pipeline to generate required samtools and bwa indexes.
When you run the pipeline, you will use the mandatory
--ref parameter to specify the location and name of the reference.fasta file:
Download the AnnotSV database and supporting files (optional)
If you choose to run the pipeline with AnnotSV annotations, you currently need to download and prepare the relevant AnnotSV files, manually. The AnnotSV data is very large (>20Gb) so we haven't included it in the AnnotSV container.
First, download the AnnotSV database:
Then unzip it and save to a directory of your choosing:
tar -xf Annotations_Human_3.2.1.tar.gz -C /path/to/AnnotSV
You will also need to download the Exomiser supporting data files:
wget https://www.lbgi.fr/~geoffroy/Annotations/2202_hg19.tar.gz && wget https://data.monarchinitiative.org/exomiser/data/2202_phenotype.zip
Create a directory to house the Exomiser files:
mkdir -p Annotations_Human/Annotations_Exomiser/2202
Save the downloaded Exomiser files to your AnnotSV directory:
tar -xf 2202_hg19.tar.gz -C /path/to/AnnotSV/Annotations_Human/Annotations_Exomiser/2202/ && unzip 2202_phenotype.zip -d /path/to/AnnotSV/Annotations_Human/Annotations_Exomiser/2202/
And finally (optionally), tidy up:
rm -rf Annotations_Human_3.2.1.tar.gz 2202_phenotype.zip 2202_hg19.tar.gz
3. Clone this repository
Download the code contained in this repository with:
git clone https://github.com/Sydney-Informatics-Hub/Germline-StructuralV-nf
This will create a directory with the following structure:
Germline-StructuralV-nf/ ├── LICENSE ├── README.md ├── config/ ├── main.nf ├── modules/ └── nextflow.config
The important features are:
- main.nf contains the main nextflow script that calls all the processes in the workflow.
- nextflow.config contains default parameters to use in the pipeline.
- modules contains individual process files for each step in the workflow.
- config contains infrastructure-specific config files (this is currently under development)
4. Run the pipeline
The most basic run command for this pipeline is:
nextflow run main.nf --input sample.tsv --ref /path/to/ref
This will generate
results output directory and a
runInfo run metrics directories. To specify additional optional tool-specific parameters, see what flags are supported by running:
nextflow run main.nf --help
AnnotSV annotations for human samples
To run the pipeline with the optional AnnotSV annotations, use the following command:
nextflow run main.nf --input sample.tsv --ref /path/to/ref --annotsv /path/to/annotsv
If for any reason your workflow fails, you are able to resume the workflow from the last successful process with
Once the pipeline is complete, you will find all outputs for each sample in the
results directory. Within each sample directory there is a subdirectory for each tool run which contains all intermediate files and results generated by each step. A final merged VCF for each sample will be created:
The following directories will be created:
- manta: all intermediate files and results generated by Manta.
- smoove: all intermediate files and results generated by Smoove.
- tiddit: all intermediate files and results generated by Tiddit.
- survivor: summary stats, merged multi-caller VCF (final output), merged multi-caller bedpe file.
- annotsv: full annotations for the all events in the merged multi-callr VCF.
Infrastructure useage and recommendations
|metadata field||GermlineStructuralV-nf / v1.0|
|License||GNU General Public License v3.0|
|Container||See Component tools|
To run this pipeline you must have Nextflow and Singularity installed on your machine. All other tools are run using containers.
- It is essential that the reference genome you're using contains the same chromosomes, contigs, and scaffolds as the BAM files. This is mandated by Manta, which will throw an error if the BAM and FASTA files do not match. To confirm what contigs are included in your indexed BAM file, you can use Samtools idxstats:
samtools idxstats input.bam | cut -f 1
- Georgie Samaha (Sydney Informatics Hub, University of Sydney)
- This pipeline was built using the Nextflow DSL2 template.
- Documentation was created following the Australian BioCommons documentation guidelines.
Cite us to support us!
Acknowledgements (and co-authorship, where appropriate) are an important way for us to demonstrate the value we bring to your research. Your research outcomes are vital for ongoing funding of the Sydney Informatics Hub and national compute facilities. We suggest including the following acknowledgement in any publications that follow from this work:
The authors acknowledge the technical assistance provided by the Sydney Informatics Hub, a Core Research Facility of the University of Sydney and the Australian BioCommons which is enabled by NCRIS via Bioplatforms Australia.
main @ 45954a4 (earliest) Created 31st Jan 2023 at 23:40 by Georgina Samaha
Merge pull request #15 from Sydney-Informatics-Hub/betarelease
Beta release complete
Created: 31st Jan 2023 at 23:40