API Reference

Every public feature is reachable directly from the top-level finaletoolkit namespace (see Top-Level Namespace). You can also import each feature from its submodule (finaletoolkit.frag, finaletoolkit.utils, finaletoolkit.genome, finaletoolkit.io).

import finaletoolkit as ftk

cov = ftk.coverage("sample.bam", "intervals.bed", output_file=None)
gaps = ftk.GenomeGaps.hg38()

Contents

• Top-Level Namespace lists everything importable from finaletoolkit.

• Basic Features covers coverage and fragment length.

• Window Protection Score (WPS) covers the Windowed Protection Score.

• DELFI covers DELFI ratios and GC correction.

• End-Motifs covers end-motif frequencies and MDS.

• Breakpoint Motifs covers breakpoint-motif frequencies.

• Cleavage Profile covers the per-nucleotide cleavage proportion.

• Frag File Utilities covers filtering, aggregation, and helpers.

• Genome Utilities covers genome gaps and annotation tracks.

• I/O Wrappers covers reference and alignment access.

• Exceptions covers the typed exception hierarchy.