Giter VIP home page Giter VIP logo

motrpac_atac_mop's Introduction

MoTrPAC ATAC-Seq MOP (ENCODE pipeline)

NOTE: (31 Jan 19) This README is currently outdated. It will be updated to reflect the most recent version of the MOP.

This repository documents the specific parameters used to run the ENCODE ATAC pipeline for ATAC-seq data processing within the MoTrPAC consortium.

Note that the ENCODE ATAC-seq pipeline has separate instructions for multiple platforms, including Stanford SCG, Stanford Sherlock 2.0, local system with docker, local system with Conda, etc. The following documentation is specific for analysis on a local system with Conda. Platform-specific instructions can be found here: https://github.com/ENCODE-DCC/atac-seq-pipeline

Contact: Nicole Gay ([email protected])

Resources:

Table of Contents:

  1. Before you do anything else...
  2. Install and test ENCODE ATAC-seq pipeline and dependencies
  3. Build a genome database
  4. Generate JSON files
  5. Run pipeline
  6. Collect important QC metrics
  7. ENCODE data quality standards

1. Before you do anything else...

Good-quality ATAC analysis requires high-output sequencing data. ENCODE stipulates that a sample should have 25M non-duplicated, filtered, non-mitochondial fragments for downstream analysis. That corresponds to 50M reads for paired-end sequencing and 25M reads for single-end sequencing AFTER a number of filtering steps. Therefore, your raw paired-end FASTQ files should have appreciably more than 50M reads per sample. Raw read counts should be included in metadata/QC metric reports for all samples.

2. Install and test ENCODE ATAC-seq pipeline and dependencies

To install a local version with Conda, follow Steps 1-8 found here: https://github.com/ENCODE-DCC/atac-seq-pipeline/blob/master/docs/tutorial_local_conda.md

Otherwise, see https://github.com/ENCODE-DCC/atac-seq-pipeline for other installation/run options.

3. Build a genome database

For human:
Follow the instructions for How to build a genome database found here: https://github.com/ENCODE-DCC/atac-seq-pipeline/blob/master/docs/build_genome_database.md using GENOME=hg38. Note that the path conda/install_genome_data.sh is located within the atac-seq-pipeline directory cloned in Step 1.

For rat:
Follow the instructions for How to build genome database for your own genome found here: https://github.com/ENCODE-DCC/atac-seq-pipeline/blob/master/docs/build_genome_database.md. Note that the path conda/install_genome_data.sh is located within the atac-seq-pipeline directory cloned in Step 1.

In Step 4, add a couple of extra things:

  • REF_FA points to a genome sequence file. Use the Ensembl hard-masked assembly of the rat genome.
  • BLACKLIST points to a BED file of regions to be masked from the rat genome. The URL in the code below provides a dummy blacklist file that does not actually mask any regions in the rat genome. This may be changed in the future.
  • TSS_ENRICH points to a BED file of transcripition start site (TSS) annotations. The URL in the code below includes rat TSS annotations curated from BioMart.

Note that the pipeline (at least the local version with Conda) requires that these inputs are provided as URLs. Inputting a path to a file in a local directory will not work. The rat blacklist and TSS annotation files can be moved to a more permanent location in the future.

So find these lines in ${PATH_TO_PIPELINE}/conda/install_genome_data.sh:

  ...

  elif [[ $GENOME == "YOUR_OWN_GENOME" ]]; then
    REF_FA="URL_FOR_YOUR_FASTA_OR_2BIT"
    BLACKLIST= # leave it empty if you don't have it

  ...

and replace them with these:

  ...

  elif [[ $GENOME == "rn6_masked" ]]; then
    REF_FA="ftp://ftp.ensembl.org/pub/release-94/fasta/rattus_norvegicus/dna/Rattus_norvegicus.Rnor_6.0.dna_rm.toplevel.fa.gz"
    BLACKLIST="http://web.stanford.edu/~nicolerg/blacklist.bed.gz"
    TSS_ENRICH="http://web.stanford.edu/~nicolerg/tss.rn6.bed.gz"

  ...

4. Generate JSON files

A JSON file specifying input parameters is required for each sample. Find documentation of definable parameters here: https://github.com/ENCODE-DCC/atac-seq-pipeline/blob/master/docs/input.md

The files directory of this repository includes a couple of files to help:

  • make_json.sh: Example code to generate JSON files for samples with a single biological replicate. See script for usage details.
  • example.json: Example of a JSON file for a sample with a single biological replicate.

Note that the genome_ref variable in make_json.sh (which is the path to the .tsv file generated in Step 3) must correspond to the correct species (i.e. human or rat).

5. Run pipeline

Actually running the pipeline to run is easy:

source activate encode-atac-seq-pipeline # IMPORTANT!
INPUT=/path/to/json
SRCDIR=/path/to/atac-seq-pipeline
java -jar -Dconfig.file=${SRCDIR}/backends/backend.conf ${SRCDIR}/cromwell-34.jar run ${SRCDIR}/atac.wdl -i ${INPUT}

A cromwell-executions directory containing all of the pipeline outputs is created in whatever directory from which you run the above command, so choose wisely. One arbitrarily-named subdirectory for each JSON file will be written in cromwell-executions/atac.

6. Collect important QC metrics

The structure of the pipeline output is a bit complex. Most of the important metrics are in a JSON report in the call-qc_report subdirectory of each run. The are also plots of TSS enrichment in call-ataqc subdirectories. The extract-atac-outputs.sh script in files pulls out these files as well as HTML QC reports, filtered BAM files, and peak files from all runs of pipeline and compiles them in a single folder. It also collapses all JSON reports into a single tab-delimited file called merged.qc.txt with section headers indicated by ##########. Note that, as written, the collapsed JSON file will not make sense if different samples have different numbers of replicates.

At a minimum, the following metadata and QC metrics should be compiled and reported for every sample:

  • sample name
  • FASTQ prefix
  • sequencing run
  • platform
  • species
  • tissue
  • sample treatment
  • number of raw FASTQ reads
  • TSS enrichment plots (from pipeline)
  • insert size distribution plot (from pipeline)

Values from JSON report (the easiest thing to do would be to submit the whole report for each sample):

  • flagstat_qc: total
  • falgstat_qc: mapped
  • flagstat_qc: mapped_pct
  • flagstat_qc: paired
  • flagstat_qc: paired_properly
  • flagstat_qc: paired_properly_pct
  • dup_qc: paired_reads
  • dup_qc: paired_dupes
  • dup_qc: dupes_pct
  • pbc_qc: total_read_pairs
  • pbc_qc: distinct_read_pairs
  • pbc_qc: NRF
  • pbc_qc: PBC1
  • pbc_qc: PBC2
  • nodup_flagstat_qc: total
  • overlap_reproducibility_qc: N_opt
  • idr_reproducibility: N_opt
  • frip_macs2_qc: all FRiP values
  • overlap_frip_qc: FRiP values
  • idr_frip_qc: FRiP values
  • ataqc: Read count from sequencer (Note that this number is higher than my counts from raw FASTQ files and probably includes multimapped reads. This needs to be checked.)
  • ataqc: Read count successfully aligned
  • ataqc: Read count after filtering for mapping quality
  • ataqc: Read count after removing duplicate reads
  • ataqc: Read count after removing mitochondrial reads (final read count)
  • ataqc: picard est library size
  • ataqc: Fraction of reads in NFR
  • ataqc: NFR/(mono-nuc reads)
  • ataqc: Raw peaks
  • ataqc: Naive overlap peaks
  • ataqc: IDR peaks
  • ataqc: TSS enrichment

See https://www.encodeproject.org/data-standards/terms/ for an explanation of some of these terms.

7. ENCODE data quality standards (https://www.encodeproject.org/atac-seq/#standards)

Metric Range Quality
Number of non-dup, non-MT aligned reads (PE) > 50M Recommended
------------------------------------------------- -------------- -----------
% mapped reads > 95% Ideal
. > 80% Acceptable
------------------------------------------------- -------------- -----------
NRF > 0.9 Recommended
------------------------------------------------- -------------- -----------
PBC1 > 0.9 Recommended
------------------------------------------------- -------------- -----------
PBC2 > 3 Recommended
------------------------------------------------- -------------- -----------
Number of reproducibitily_overlap peaks > 150k Ideal
. > 100k Acceptable
------------------------------------------------- -------------- -----------
Number of reproducibililty_idr peaks > 70k Ideal
. > 50k Acceptable
------------------------------------------------- -------------- -----------
FRiP (fraction of reads in peaks) > 0.3 Ideal
. > 0.2 Acceptable
------------------------------------------------- -------------- -----------
TSS enrichment (GRCh38) > 7 Ideal
. 5-7 Acceptable
. < 5 Concerning

motrpac_atac_mop's People

Contributors

nicolerg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.