Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
> [preseq](https://github.com/smithlabcode/preseq) `lc_extrap`)
> - **samtools-compatible** flagstat, idxstats, and full stats output
> - **Gene body coverage** profiling with Qualimap-compatible output
> - **bigWig** genome coverage tracks (nf-core/rnaseq-compatible; bedtools
> `genomecov` + UCSC `bedClip` semantics)
>
> Binary crate (`rustqc`), Rust edition 2021.

Expand Down Expand Up @@ -63,7 +65,7 @@ src/
io.rs — Shared I/O utilities (gzip-transparent file reading)
gtf.rs — GTF annotation file parser (with configurable attribute extraction)
rna/
mod.rs — Re-exports all submodules (dupradar, featurecounts, rseqc, bam_flags, cpp_rng, preseq, qualimap)
mod.rs — Re-exports all submodules (dupradar, featurecounts, rseqc, bam_flags, cpp_rng, preseq, qualimap, bigwig)
bam_flags.rs — BAM flag constants
cpp_rng.rs — C++ RNG FFI shim for preseq bootstrap reproducibility
dupradar/
Expand All @@ -76,6 +78,10 @@ src/
mod.rs — Re-exports output
output.rs — featureCounts-format output & biotype counting
preseq.rs — preseq lc_extrap library complexity extrapolation
bigwig/
mod.rs — Re-exports accumulator and output
accumulator.rs — bedtools genomecov difference-array coverage accumulation
output.rs — bedClip semantics + bigWig writing via bigtools
qualimap/
mod.rs — Re-exports all Qualimap modules
accumulator.rs — Gene body coverage accumulation logic
Expand Down Expand Up @@ -120,8 +126,9 @@ dupRadar duplicate rate analysis, featureCounts-compatible gene counting,
all 8 RSeQC-equivalent tools (bam_stat, infer_experiment, read_duplication,
read_distribution, junction_annotation, junction_saturation, inner_distance,
TIN), preseq library complexity extrapolation, samtools-compatible outputs
(flagstat, idxstats, stats), and gene body coverage profiling with
Qualimap-compatible output. The GTF parser extracts transcript-level
(flagstat, idxstats, stats), gene body coverage profiling with
Qualimap-compatible output, and nf-core/rnaseq-compatible bigWig coverage
tracks. The GTF parser extracts transcript-level
structure (exons + CDS features) to derive all data needed by every tool.

Individual tools can be disabled via the YAML config file (each has an `enabled`
Expand Down Expand Up @@ -255,6 +262,8 @@ To prepare a release:
| `rayon` | Data parallelism |
| `rand` / `rand_chacha` | Reproducible random sampling |
| `flate2` | Gzip decompression (annotation files) |
| `bigtools` | bigWig file writing |
| `tokio` | Async runtime for bigtools |

## Duplicate Marking Validation

Expand Down Expand Up @@ -294,7 +303,7 @@ forwarded to `count_reads()` as the `skip_dup_check: bool` parameter).
`infer_experiment:`, `read_duplication:`, `read_distribution:`, `junction_annotation:`,
`junction_saturation:`, `inner_distance:`, `tin:`). Each has an `enabled: bool` toggle
and tool-specific parameter overrides. CLI flags take precedence over config values.
- Under `rna:`, there are also sections for `preseq:`, `qualimap:`,
- Under `rna:`, there are also sections for `preseq:`, `qualimap:`, `bigwig:`,
`flagstat:`, `idxstats:`, and `samtools_stats:`. Each has an `enabled: bool` toggle.
Preseq has additional parameters: `max_extrap`, `step_size`, `n_bootstraps`,
`confidence_level`, `seed`, `max_terms`, `defects`. TIN has `sample_size` and
Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# RustQC Changelog

## Unreleased

### Features

- Add bigWig genome coverage tracks in the existing BAM streaming pass, matching nf-core/rnaseq `bedtools genomecov` + UCSC `bedClip` + `bedGraphToBigWig` output ([#112](https://github.com/seqeralabs/RustQC/issues/112))

### Documentation

- Document bigWig coverage tracks on the docs site, README, AGENTS.md, and related markdown files

## [Version 0.2.1](https://github.com/seqeralabs/RustQC/releases/tag/v0.2.1) - 2026-04-09

### Bug fixes
Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ src/
gtf.rs GTF annotation file parser
rna/
mod.rs Re-exports all submodules (bam_flags, cpp_rng, dupradar,
featurecounts, preseq, qualimap, rseqc)
featurecounts, preseq, qualimap, bigwig, rseqc)
bam_flags.rs BAM flag constants
cpp_rng.rs C++ RNG FFI shim for preseq bootstrap reproducibility
dupradar/
Expand All @@ -99,6 +99,10 @@ src/
mod.rs Re-exports output
output.rs featureCounts-format output and biotype counting
preseq.rs preseq lc_extrap library complexity extrapolation
bigwig/
mod.rs Re-exports accumulator and output
accumulator.rs bedtools genomecov coverage accumulation
output.rs bedClip semantics + bigWig writing
qualimap/
mod.rs Re-exports accumulator, coverage, index, output, plots, report
accumulator.rs Gene body coverage accumulator
Expand Down
Loading
Loading