Skip to content

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

License

Notifications You must be signed in to change notification settings

epifluidlab/FinaleToolkit

Repository files navigation

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:

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.

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).
  • Sequence Alignment Map (.sam) files.
  • 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.