How mydennislab/cifi-toolkit works
cifi-toolkit processes CiFi long reads from QC through in-silico digestion and contact generation, with an alternate unique-segment mapping route for reconstructing contacts. The CLI also exposes alignment filtering and enzyme information; outputs include reports and contact files for downstream tools. The graph combines documented workflows with source-index references and shown calls. Some command implementations and report wiring were not excerpted, so those relationships are documented rather than inferred from module names.
Main entry points: digestion.cpp Read digestion · cli.py CLI commands · contacts.cpp Pair reconstruction · cifi.cpp Read QC
Components 19
User interface
- CLI commands
src/cifi/cli.py
Read processing
- Read QC
src/cifi_cpp/cifi.cpp - Enzyme definitions
src/cifi_cpp/core/enzyme.cpp - Read digestion
src/cifi_cpp/core/digestion.cpp - Segment naming
src/cifi_cpp/core/segment_name.cpp - Alignment filter
src/cifi_cpp/filter/bam_filter.cpp - FASTQ parsing
extern/kseq.h
Contact reconstruction
- Pair reconstruction
src/cifi_cpp/contacts/contacts.cpp - Segment alignments
Output and analysis
- Statistics
src/cifi_cpp/stats/statistics.cpp - File writers
src/cifi_cpp/io/writer.cpp - Report generation
src/cifi/report.py - Hash map utilities
extern/parallel_hashmap/parallel_hashmap - Paired FASTQ
- Unique segments
- BED or PA5 contacts
- QC report
Other components
- Researcher
- Assembly or scaffolding
Connections 26
- Researcher → CLI commands: runs commands
README.md - CLI commands → Read QC: runs QC
README.md - CLI commands → Read digestion: runs digestion
src/cifi/cli.py - CLI commands → Enzyme definitions: lists enzymes
README.md - CLI commands → Alignment filter: runs filtering
README.md - CLI commands → Pair reconstruction: reconstructs contacts
README.md - CLI commands → Report generation: generates reports
src/cifi/cli.py - Read QC → Enzyme definitions: uses site
- Read digestion → Enzyme definitions: uses site
- Read digestion → Statistics: records metrics
- Read digestion → File writers: writes reads
- Read digestion → Segment naming: names segments
- FASTQ parsing → Read digestion: parses FASTQ
- Pair reconstruction → Segment naming: parses names
src/cifi_cpp/contacts/contacts.cpp - Pair reconstruction → File writers: writes contacts
src/cifi_cpp/contacts/contacts.cpp - Pair reconstruction → Statistics: collects metrics
- Statistics → Hash map utilities: uses hash map
- Read digestion → Paired FASTQ: emits pairs
README.md - Read digestion → Unique segments: emits segments
README.md - Unique segments → Segment alignments: mapped externally
README.md - Segment alignments → Pair reconstruction: reconstructs pairs
README.md - Pair reconstruction → BED or PA5 contacts: writes BED or PA5
- Read QC → QC report: summarizes reads
README.md - Report generation → QC report: renders report
src/cifi/report.py - BED or PA5 contacts → Assembly or scaffolding: feeds scaffolding
README.md - Paired FASTQ → Assembly or scaffolding: feeds assembly
README.md