README.md

Introduction

nf-core/pacvar is a bioinformatics pipeline that processes long read pacbio data. Specifically the pipeline contains two workflows, one to process whole genome sequence data and other to process reads from the PureTarget expansion panel Pacbio offers - this repeat workflow characterizes tandem repeats. The workflow, is designed for pacbio reads and thus uses Pacbio's released tools.

1. Demultiplex reads (lima)
2. Align reads (lima)
3. Sort and Index alignments (SAMtools)

wgs workflow

1. Choice of SNP calling routes: a. (deepvariant) b. (HaplotypeCaller)
2. Call SVs (pbsv)
3. Index VCF files (bcftools)
4. Phase SNPS, SVs and BAM files (hiphase)

repeat workflow

1. Genotype tandem repeats - produce spanning bams and vcf (TRGT)
2. Index and Sort tandem tepeat spanning bam (SAMtools)
3. Plot repeat motif plots (TRGT)
4. Sort spanning VCF (bcftools)

Usage

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

samplesheet.csv:

sample,bam,bai
CONTROL,AEG588A1_S1_L002_R1_001.bam,AEG588A1_S1_L002_R1_001.bai

Each row represents an unaligned bam file and their associated index.

Now, you can run the pipeline using:

nextflow run nf-core/pacvar \
   -profile <docker/singularity/.../institute> \
   --input samplesheet.csv \
   --outdir <OUTDIR> \ 
   --workflow <wgs/repeat> \
   --barcodes barcode.fasta \
   --intervals intervals.bed

optional paramaters include: --skip_demultiplexing, --skip_snp --skip_sv --skip_phase

Warning

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

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Credits

nf-core/pacvar was originally written by Tanya Sarkin Jain.

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.

For further information or help, don't hesitate to get in touch on the Slack #pacvar channel (you can join with this invite).

Citations

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

You can cite the nf-core publication as follows:

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.