Skip to main content

FinaleToolkit is a package and standalone program to extract fragmentation features of cell-free DNA from paired-end sequencing data.

Project description

dna with letters FT ‎ ‎ ‎FinaleToolkit

Table of Contents

  1. About The Project
  2. Installation
  3. Usage
  4. Contact
  5. License

About The Project

FinaleToolkit (FragmentatIoN AnaLysis of cEll-free DNA Toolkit) is a package and standalone program to extract fragmentation features of cell-free DNA from paired-end sequencing data.

Citation

If you use FinaleToolkit in your research, please consider citing our paper:

James Wenhan Li, Ravi Bandaru, Kundan Baliga, Yaping Liu, FinaleToolkit: Accelerating Cell-Free DNA Fragmentation Analysis with a High-Speed Computational Toolkit, Bioinformatics Advances, 2025;, vbaf236, https://doi.org/10.1093/bioadv/vbaf236

Installation

You can install the package using conda.

$ conda install -c bioconda -c conda-forge finaletoolkit

You can also install the package using pip.

$ pip install finaletoolkit

Usage

Functionality

FinaleToolkit has support for the following cell-free DNA fragmentation features:

  • Fragment Length
  • Coverage
  • End Motifs DOI
  • Motif Diversity Score DOI
  • Windowed Protection Score DOI
  • DELFI DOI
  • Cleavage Profile DOI

Documentation

Documentation for FinaleToolkit can be found here.

Wiki/Tutorials

The wiki and tutorial page for FinaleToolkit can be found here.

Compatible File Formats

FinaleToolkit is compatible with almost any paired-end sequence data:

  • Binary Alignment Map (.bam) files with an associated index file (.bam.bai).
  • Compressed Reference-oriented Alignment Map (.cram) files.
  • Fragment (.frag.gz) files with an associated tabix index file (.frag.gz.tbi).

Using Fragment Files

Fragment (.frag.gz) files are block-gzipped BED3+2 files with the following columns: chrom , start , stop , mapq , strand.

We encourage you to use our comprehensive database, FinaleDB, to access relevant fragment files. Learn more about FinaleDB here.

Snakemake workflow

Check out our Snakemake workflow!

Contact

License

This project falls under an MIT license. See the included LICENSE file for details.

Project details


Download files

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

Source Distribution

finaletoolkit-0.12.0.tar.gz (100.9 kB view details)

Uploaded Source

Built Distribution

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

finaletoolkit-0.12.0-py3-none-any.whl (105.7 kB view details)

Uploaded Python 3

File details

Details for the file finaletoolkit-0.12.0.tar.gz.

File metadata

  • Download URL: finaletoolkit-0.12.0.tar.gz
  • Upload date:
  • Size: 100.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for finaletoolkit-0.12.0.tar.gz
Algorithm Hash digest
SHA256 9221ac964bade3787ea4c8c356463898834743cc5fadeb6846f82630b99f4725
MD5 e15e411cc90b91d47eff63664939f011
BLAKE2b-256 1dded77a5442873064a63273c14af2befdf9e653f1beed114c37e2c80ef2561c

See more details on using hashes here.

Provenance

The following attestation bundles were made for finaletoolkit-0.12.0.tar.gz:

Publisher: python-publish.yml on epifluidlab/FinaleToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file finaletoolkit-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: finaletoolkit-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 105.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for finaletoolkit-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8512990acdaac22fbf906e15e2486ebaab05db8ed1b17e9323aa26d6d73a082
MD5 9b0fc45bdfd40d5a55579b2d3b32735e
BLAKE2b-256 1a41e7da53c6a1304c51b8327488a8b62be68e64e9a0dcdb123efb0fa4fbb720

See more details on using hashes here.

Provenance

The following attestation bundles were made for finaletoolkit-0.12.0-py3-none-any.whl:

Publisher: python-publish.yml on epifluidlab/FinaleToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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