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:

Li J*, Bandaru R*, Liu Y (2024) FinaleToolkit: Accelerating Cell-Free DNA Fragmentation Analysis with a High-Speed Computational Toolkit. BioRxiv Preprint Static Badge

Installation

You can 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.

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.10.4.tar.gz (83.0 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.10.4-py3-none-any.whl (85.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finaletoolkit-0.10.4.tar.gz
  • Upload date:
  • Size: 83.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for finaletoolkit-0.10.4.tar.gz
Algorithm Hash digest
SHA256 e40d3cec640c54e4b493ef7214c2e90b4dde369693d14c0af8d6320804e68429
MD5 989ee84de9fcac600ae75148b8c2ab13
BLAKE2b-256 2719b2ab0faa52af88d19152a7e627490a31790ce3536b1eaa162c299811f0c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for finaletoolkit-0.10.4.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.10.4-py3-none-any.whl.

File metadata

  • Download URL: FinaleToolkit-0.10.4-py3-none-any.whl
  • Upload date:
  • Size: 85.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for FinaleToolkit-0.10.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f3fd9c212e1fde6acf01bd2f4d093388bfa44ac1ab5037253dc6417d652ed76f
MD5 87220c0e6d1dca0f4dbc6a655c826c07
BLAKE2b-256 79330117146aee0800fe501a48de96e0e87b1222a8bd522005bdd64264f5ce1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for FinaleToolkit-0.10.4-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