Skip to main content

fp-tools — regulatory footprinting

PyPI CI License: MIT

Documentation · Output demo with ENCODE cancer cell lines · GUI demo · PyPI

fp-tools is a command-first toolkit for ATAC-seq bias correction, footprint scoring, motif analysis, replicate-aware comparisons, and single-cell footprint signatures. The optional GUI and YAML runner call the same commands.

Install

pip install fp-tools-bio

For the GUI:

pip install "fp-tools-bio[gui]"
fp-tools-gui

Bulk ATAC-seq

bulk-footprinting runs the complete analysis from aligned BAM and peak files. FASTQ preparation remains available separately through prepare-atac.

bulk-footprinting \
  --sample-table samples.tsv \
  --comparison-table comparisons.tsv \
  --genome hg38.fa.gz \
  --blacklist hg38.blacklist.bed \
  --outdir project \
  --cores 8

The wrapper runs atac-correct, call-footprints, match-motifs, diff-footprints, and review-multi-comparisons. Each command can also be run directly.

Single-cell ATAC-seq

sc-footprinting groups fragments, runs pseudobulk footprinting, and produces per-cell KNN footprint-signature heatmaps and UMAPs.

sc-footprinting \
  --fragments fragments.tsv.gz \
  --annotations cell_annotations.tsv \
  --h5ad embedding.h5ad \
  --group-by cell_type \
  --genome-sizes hg38.chrom.sizes \
  --genome hg38.fa.gz \
  --peaks merged_peaks.bed \
  --outdir project/single_cell

Main commands

Area Commands
Core analysis prepare-atac, atac-correct, call-footprints, match-motifs, diff-footprints, normalize-bigwig
Workflows bulk-footprinting, sc-footprinting, run-yaml-workflow, fp-tools-gui
Reports plot-aggregate, review-multi-comparisons
De novo motifs discover-motifs, summarize-motifs
Single-cell utilities pseudobulk-fragments, find-signature-fp

Use <command> --help for complete options. Practical examples and the API reference are available in the documentation.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fp_tools_bio-0.1.17.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fp_tools_bio-0.1.17-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (2.9 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

File details

Details for the file fp_tools_bio-0.1.17.tar.gz.

File metadata

  • Download URL: fp_tools_bio-0.1.17.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for fp_tools_bio-0.1.17.tar.gz
Algorithm Hash digest
SHA256 98e38d0e3cfceee09a379a54f2b91008bef444b3b5dfadefcd2d3e876e612f4d
MD5 259b1644bbb2cd1153c4c48d2f8ec9b2
BLAKE2b-256 f815a2897119efece4c05ef43bd44c51410d3d7a9f5812b9ae989d1e3308c394

See more details on using hashes here.

File details

Details for the file fp_tools_bio-0.1.17-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for fp_tools_bio-0.1.17-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 0f86a08008f87bed75f4f5c1f6e7a3dd0675e7887e634df608defcf77c5e2849
MD5 6354ca76e9e4242a5f2d59a778de52df
BLAKE2b-256 d1454e4c1d9baa2830cc757c25e7de2af2b76d1cbf5df5bf5d6b8402bf8f04de

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.18

2 files

This release

0.1.17 This release

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

1 file

0.1.8

1 file

0.1.7

1 file

0.1.6

1 file

0.1.5

1 file

0.1.4

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page