Skip to content

diff-footprints

Find motifs whose footprint scores differ between conditions. Start with the per-sample results from match-motifs. You can also compare two sets of genomic regions measured in the same samples.

Example command

diff-footprints \
  --sample-table project/metadata/samples.tsv \
  --comparison-table project/metadata/comparisons.tsv \
  --genome hg38.fa.gz \
  --peaks project/peaks/merged_peaks_filtered.bed \
  --motif-db jaspar2026_vertebrates \
  --outdir project

Primary inputs

  • --sample-table — TSV with sample and condition columns. Reuse the table from the earlier steps; the command finds results under {project}/samples/{sample}/.
  • --comparison-table — TSV with comparison, cond1, and cond2 columns. Each row names one comparison and its two condition labels.
  • --genome — the reference FASTA used for motif matching.
  • --peaks — accessible-region BED file.
  • --motif-db — built-in motif database name.
  • --outdir — project directory for statistics, figures, and HTML reports.

Condition labels must match the sample table. Include each biological replicate as its own sample row. See the sample and comparison tables for a minimal example.

Main outputs

Each comparison is written below {project}/comparisons/{comparison}/, where {comparison} is taken from the comparison table and {prefix} defaults to diff_footprints:

Path Meaning
{prefix}_results.txt Tab-separated motif-level differential footprint statistics; change direction is cond1 - cond2.
{prefix}_results.xlsx Excel copy in direct runs unless --skip-excel is used. Project comparison-table runs, including the example above, omit it.
{prefix}_distances.txt Motif distances used for clustering related motifs.
{prefix}_{cond1}_{cond2}.html Portable interactive report with volcano, motif, and embedded aggregate-profile views.
{prefix}_replicate_report.tsv Long-form per-replicate diagnostic data when replicate reporting is active.
{prefix}_replicate_summary.tsv Motif-level replicate agreement summary.
{prefix}_replicate_report.png Replicate diagnostic figure.
{prefix}_figures.pdf and {prefix}_clusters.pdf Optional static summaries written with --static-plots.
{motif}/beds/{motif}_{condition}_bound.bed Motif instances classified as bound for a condition when full motif outputs are required.

Open the HTML report to explore motifs, then use the text result table for further analysis. Positive changes favor cond1; negative changes favor cond2. Check replicate agreement and the aggregate cut-site profiles along with the statistics when interpreting a difference.

Compare region sets

Region-set analyses use the same result/report patterns and add confidence intervals, motif prevalence, region counts, per-replicate effects, and matching balance to the result tables.

For a region-set comparison, use --comparison-axis regions, provide two or more BED files with --regions, and name them with --region-labels. An optional --region-strata-column preserves accessibility or other matching strata during resampling. One sample uses a stratified label-permutation test; two or more biological replicates use a paired empirical-Bayes model. Use --plot-aggregate-motifs to choose an ordered aggregate panel without limiting the motifs tested, and --default-aggregate-plots to set its initial size.

See the Bulk output example, the region-set comparison example, and the complete diff-footprints reference.