aDNAMap

adnamap is a bioinformatics best-practice analysis pipeline for aDNA mapping to mulitple genomes.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!

On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources. The results obtained from the full-sized test can be viewed on the nf-core website.

Pipeline summary

Read QC (FastQC)
Present QC for raw reads (MultiQC)

Quick Start

Install Nextflow (>=21.10.3)
Install any of Docker, Singularity (you can follow this tutorial), Podman, Shifter or Charliecloud for full pipeline reproducibility (you can use Conda both to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see docs).
Download the pipeline and test it on a minimal dataset with a single command:
```
nextflow run nf-core/adnamap -profile test,YOURPROFILE --outdir <OUTDIR>
```
Note that some form of configuration will be needed so that Nextflow knows how to fetch the required software. This is usually done in the form of a config profile (YOURPROFILE in the example command above). You can chain multiple config profiles in a comma-separated string.
- The pipeline comes with config profiles called docker, singularity, podman, shifter, charliecloud and conda which instruct the pipeline to use the named tool for software management. For example, -profile test,docker.
- Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile <institute> in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.
- If you are using singularity, please use the nf-core download command to download images first, before running the pipeline. Setting the NXF_SINGULARITY_CACHEDIR or singularity.cacheDir Nextflow options enables you to store and re-use the images from a central location for future pipeline runs.
- If you are using conda, it is highly recommended to use the NXF_CONDA_CACHEDIR or conda.cacheDir settings to store the environments in a central location for future pipeline runs.

Start running your own analysis!

nextflow run nf-core/adnamap --input samplesheet.csv  --genomes genome_sheet.csv --outdir <OUTDIR> -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>

Documentation

The adnamap pipeline comes with documentation about the pipeline usage, parameters and output.

Credits

nf-core/adnamap was originally written by Maxime Borry.

Pipeline workflow

flowchart TD
    subgraph fastq_process[FastQ preprocessing]
        fastq{FastQ file}
        fastqc_before[FastQC before]
        fastp["fastp: \n Adapter and Quality trimming + merging + deduplication"]
        fastqc_after[FastQC after]
        fastq --> fastqc_before
        fastq --> fastp
        fastp -- Trimmed fastq --> fastqc_after
    end
    subgraph fastq_preproprecessing[FastA preprocessing]
        fasta{Genome FastA file}
        faidx[Samtools faidx]
        fasta --compressed-->gunzip
        gunzip-->bowtie2_build
        bowtie2_build[Bowtie2-build]
        fasta--not compressed--> bowtie2_build
        gunzip-->faidx
        fasta--not compressed-->faidx
    end
    subgraph alignment[Alignment]
        bowtie2_align["Bowtie2 align subworkflow"]
        bowtie2_build --Bowtie 2 index--> bowtie2_align
        fastp --Trimmed fastq--> bowtie2_align
    end
    subgraph alignment_post[Alignment post_processing]
        qualimap[Alignment stats reporting]
        damageprofiler[DamageProfiler: aDNA stats]
        fasta--decompressed-->damageprofiler
        gunzip-->damageprofiler
        bowtie2_align--BAM+index-->damageprofiler
        bowtie2_align--BAM+index-->qualimap
    end
    subgraph variant_calling[Variant calling]
        snpAD["snpAD: ancient DNA damage aware genotyper"]
        freebayes["Freebayes: genotyper"]

        bowtie2_align--BAM+index-->snpAD
        bowtie2_align--BAM+index-->freebayes
        fasta--decompressed-->snpAD
        gunzip-->freebayes
        faidx-->freebayes
        fasta--decompressed-->snpAD
        gunzip-->freebayes
        faidx-->snpAD
        vcf1{VCF}
        vcf2{VCF}
        snpAD --> vcf1
        freebayes --> vcf2
    end

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

Citations

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

This pipeline integrates code templates and was made with tools from the nf-core community. More in their publication below:

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.

maxibor/adnamap