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.5.tar.gz (83.1 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.5-py3-none-any.whl (85.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finaletoolkit-0.10.5.tar.gz
  • Upload date:
  • Size: 83.1 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.5.tar.gz
Algorithm Hash digest
SHA256 08b3b86bec91f56afb3889fa983fb4e46969226684dda821c295673faac8c347
MD5 e901a761ac05460a878247651e346a6a
BLAKE2b-256 2967fe74591dfc68390da1d552efe51d857ffc1f267d6f900f569680cb820d46

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: FinaleToolkit-0.10.5-py3-none-any.whl
  • Upload date:
  • Size: 85.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a1c92717a252a9d644cab1d86eaa5a1434a6741e0363f2e7ab698ea335d16233
MD5 f4fd7fa63b30699f60333640db10b516
BLAKE2b-256 1c8e4bc366bfbab9ed0afcc0fbaff5ab5b8be8d1a6c18530fc4603e8fa6b264d

See more details on using hashes here.

Provenance

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