NucFlag
Generates nucleotide frequency plots and genome misassembly BED files. Fork of NucFreq.
Quickstart
# Requires Python>=3.11
pip install nucflag>=1.0.0
Align long-reads to assembly.
# Align long reads to assembly generated from those reads.
minimap2 -x lr:hqae -I 8G asm.fa.gz reads.fq.gz | samtools view -bh -o asm.bam
samtools index asm.bam
Detect misassemblies.
# Call putative misassemblies from read alignments on a whole genome.
nucflag call -i asm.bam -f asm.fa.gz -o misassemblies.bed
# Or on a set of regions...
nucflag call -i asm.bam -f asm.fa.gz -b regions.bed -o misassemblies.bed
# Also runs on ONT read alignments.
nucflag call -i asm_ont_r9.bam -f asm.fa.gz -x ont_r9 -o misassemblies.bed
nucflag call -i asm_ont_r10.bam -f asm.fa.gz -x ont_r10 -o misassemblies.bed
# Provide a configfile for finer control.
nucflag call -i asm.bam -f asm.fa.gz -o misassemblies.bed -c config.toml
Visualize misassemblies in a number of ways.
# Generate NucFreq plots.
nucflag call -i asm.bam -f asm.fa.gz -d plots
# And add any number of tracks...
nucflag call -i asm.bam -f asm.fa.gz -d plots --tracks repeatmasker.bed segdups.bed
# Or generate bigWigs of specific signals and then merge them with `bigtools`.
# For use in IGV or other genome browsers.
nucflag call -i asm.bam -f asm.fa.gz -d plots \
--output_pileup_dir bigwigs \
--add_pileup_data cov mismatch mapq
bigwigmerge -l <(find bigwigs -name "*_first.bw") merged_first.bw
Generate status BED or breakdown showing distribution of assembly issues.
nucflag status -i misassemblies.bed > status.bed
# Get status of specific regions from a given BED file.
nucflag status -i misassemblies.bed -b censat.bed -g name > status_censat.bed
# Or plot by "length"
nucflag breakdown -i misassemblies.bed -o breakdown -t percent
Estimate QV from BED file.
nucflag qv -i misassemblies.bed > qv.bed
Generate ideogram.
nucflag ideogram -i misassemblies.bed -o ideogram
# Add cytobands with a BED file with chrom, start, end, name, and btype.
nucflag ideogram -i misassemblies.bed -c cytobands.bed -o ideogram
Get consensus misassembly calls by intersection.
nucflag consensus -i nucflag_ont.bed nucflag_hifi.bed hmm_flagger_hifi.bed hmm_flagger_ont.bed > consensus.bed
Generate sample config.
nucflag config -x ont_r10 > config_r10.toml
Input
- BAM file of PacBio HiFi, ONT R9, or ONT R10 reads aligned to an assembly.
- (Recommended) Assembly.
- (Optional) BED file of regions.
Output
- BED file of misassemblies.
- (Optional) Plots with coverage and mismatch pileup with misassemblies flagged.
- (Optional) bigWigs of pileup signals.
- (Optional) BED file of assembly status.
Documentation
Read the docs at the NucFlag wiki for more information.
Metadata
Release files for nucflag 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nucflag-1.0.2.tar.gz | 28.8 kB | Without provenance | Details for nucflag-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nucflag-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for nucflag-1.0.2-py3-none-any.whl |
Total release size: 63.7 kB
Release files / nucflag-1.0.2.tar.gz
| Download URL | nucflag-1.0.2.tar.gz |
|---|---|
| Size | 28.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
babeeae0574e64ca5a868c089912de9c93b7175c36e8195dd4150964203fa956
|
|
BLAKE2b-256 checksum How to use checksums |
6113c7a96edd14203b6aa155ed24c2c6e110cc98e455994697e6fad0999c1f37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / nucflag-1.0.2-py3-none-any.whl
| Download URL | nucflag-1.0.2-py3-none-any.whl |
|---|---|
| Size | 34.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
10e293dcd052d7099543c39f8dedac97e58fddd26884f95c09740e06128d152f
|
|
BLAKE2b-256 checksum How to use checksums |
b750066bc16fa501951f1f3738da13a27d854be510c3e8e161dd125f4477577b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Security for nucflag 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.