Skip to main content

    Epigenomics inputs and parameters

    BAM file requirements, peak calling parameters, genome assemblies, statistical thresholds, and methylation options for all epigenomics tools.

    epigenomicsinputs

    You provide an aligned BAM file per sample. The peak- and methylation-calling tools (atacseq_peaks, chipseq_peaks, methylation_call) take a BAM directly; the differential and DMR tools (atacseq_differential, chipseq_differential, methylation_dmr) instead take the per-sample peak or methylation files those calling tools produced, plus a sample metadata file and a contrast string — run the calling step on each replicate first. BAM quality (sorted, indexed, deduplicated) and running the calling step before the differential step are what most affect whether the results are trustworthy.

    Epigenomics inputs and parameters

    BAM file requirements

    All epigenomics tools accept aligned BAM files. For best results, BAM files should meet these criteria:

    RequirementDetails
    FormatBAM (Binary Alignment Map)
    SortedCoordinate-sorted
    IndexedBAI index file present
    DuplicatesMarked (Picard or samtools markdup)
    AlignmentAligned to a supported reference genome
    QualityMAPQ ≥ 30 recommended (filtered by tools)
    StepToolCommand Example
    AlignmentBWA-MEM2 or Bowtie2bwa-mem2 mem ref.fa reads.fq
    Sortsamtoolssamtools sort -o sorted.bam
    Mark duplicatesPicardpicard MarkDuplicates
    Indexsamtoolssamtools index sorted.bam

    Supported reference genomes

    The calling tools (atacseq_peaks, chipseq_peaks, methylation_call) accept a genome parameter restricted to two values; the differential and DMR tools work from files already tied to a genome and don't take a separate genome parameter.

    GenomeOrganismAssembly
    hg38HumanGRCh38 (default)
    mm10MouseGRCm38

    ATAC-seq Peak Calling parameters

    ParameterTypeRequiredDefaultDescription
    bam_file_uristringYes--URI of the aligned ATAC-seq BAM file
    genomestringNo"hg38"Reference genome: "hg38" or "mm10"
    peak_callerstringNo"macs2"Peak calling algorithm: "macs2", "hmmratac", "genrich"
    broad_peaksbooleanNofalseCall broad peaks instead of narrow

    Peak mode selection

    broad_peaksBest ForTypical Width
    false (narrow)Promoters, TF footprints, NFRs100-500 bp
    true (broad)Large regulatory domains, super-enhancers1,000-50,000 bp

    ATAC-seq Differential parameters

    atacseq_differential takes the peak files atacseq_peaks produced — it does not take raw BAMs.

    ParameterTypeRequiredDefaultDescription
    peak_filesstring[]Yes--URIs of peak files from atacseq_peaks, one per sample
    metadata_file_uristringYes--URI of a sample metadata CSV (sample, condition columns)
    contraststringYes--Contrast to test, e.g. "treated_vs_control"
    methodstringNo"diffbind"Differential method: "diffbind" or "deseq2"

    ChIP-seq Peak Calling parameters

    ParameterTypeRequiredDefaultDescription
    treatment_bam_uristringYes--URI of the ChIP treatment BAM file
    control_bam_uristringNo--URI of the input/control BAM file (strongly recommended)
    genomestringNo"hg38"Reference genome: "hg38" or "mm10"
    histone_markstringNo--Histone mark name (e.g. H3K4me3, H3K27ac) — informs peak calling
    peak_callerstringNo"macs3""macs3" (default, successor to MACS2), "macs2", or "sicer2"

    Peak caller by mark

    Histone Mark / FactorRecommended peak_callerSignal Shape
    H3K4me3macs3 (default)Sharp, promoter-associated
    H3K27acmacs3 (default)Sharp, enhancer/promoter
    H3K4me1macs3 (default)Moderate, enhancer
    H3K27me3sicer2Diffuse, repressive domains
    H3K36me3sicer2Diffuse, gene body
    H3K9me3sicer2Diffuse, heterochromatin
    CTCFmacs3 (default)Sharp, insulator binding

    ChIP-seq Differential parameters

    chipseq_differential takes the peak files chipseq_peaks produced — it does not take raw BAMs.

    ParameterTypeRequiredDefaultDescription
    peak_filesstring[]Yes--URIs of peak files from chipseq_peaks, one per sample
    metadata_file_uristringYes--URI of a sample metadata CSV (sample, condition columns)
    contraststringYes--Contrast to test, e.g. "treated_vs_control"

    Methylation Calling parameters

    ParameterTypeRequiredDefaultDescription
    bam_file_uristringYes--URI of the bisulfite-aligned BAM file
    genomestringNo"hg38"Reference genome: "hg38" or "mm10"
    methodstringNo"bismark"Methylation calling method: "bismark" or "bsmap"
    min_coverageintegerNo5Minimum read coverage to report a CpG

    The tool reports CpG methylation; it does not take a context parameter to switch to CHG/CHH (plant-only contexts).

    Methylation DMR Detection parameters

    methylation_dmr takes the methylation files methylation_call produced — it does not take raw BAMs.

    ParameterTypeRequiredDefaultDescription
    methylation_filesstring[]Yes--URIs of methylation files from methylation_call, one per sample
    metadata_file_uristringYes--URI of a sample metadata CSV (sample, condition columns)
    contraststringYes--Contrast to test, e.g. "tumor_vs_normal"
    methodstringNo"dmrseq"DMR detection method: "dmrseq", "bsseq", "methylkit"

    Was this page helpful?

    Loading...