Skip to content

Commit 62536b2

Browse files
docs: add CHANGELOG.md with project history
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 8e6c3ce commit 62536b2

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed

CHANGELOG.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Changelog
2+
3+
All notable changes to the aa-tRNA-seq pipeline are documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
7+
## [Unreleased]
8+
9+
### Added
10+
- Optional WarpDemuX barcode demultiplexing support for pooled/multiplexed sequencing runs (#74)
11+
- Optimized modkit thresholds from ModkitOpt
12+
- Pixi package manager support as primary environment manager
13+
- Mermaid diagram for workflow visualization
14+
15+
### Changed
16+
- Updated README to use pixi instead of conda (#72)
17+
- Normalized file permissions across repository
18+
19+
## [0.6.0] - 2025-11-07
20+
21+
### Added
22+
- Claude Code session start hook for automated development setup (#69)
23+
- Comprehensive CI/CD build and test checks (#68)
24+
- New project initialization structure (#65)
25+
26+
### Changed
27+
- Prefer pandas over polars for stability on some cluster nodes
28+
- Reduced Remora logging level
29+
30+
## [0.5.0] - 2025-06-22
31+
32+
### Added
33+
- LSF-specific cluster configuration (#63)
34+
35+
### Changed
36+
- Renamed test directory to recommended `.tests/` location
37+
- Reduced and made optional dorado verbosity
38+
- Downgraded numpy to fix remora stats compatibility
39+
40+
## [0.4.0] - 2025-03-16
41+
42+
### Added
43+
- Modkit integration for RNA modification analysis (#59)
44+
- `modkit_pileup` rule for modification pileups
45+
- `modkit_summary` rule for modification summaries
46+
- `modkit_extract` and `modkit_extract_full` rules for detailed modification data
47+
- Automatic dorado and model download/installation (#56)
48+
- Modified base calling support (pseU, m5C, inosine_m6A)
49+
- Full modkit outputs with optimized memory allocation
50+
51+
### Changed
52+
- Eliminated support for FAST5 files - pipeline now POD5-only (#43)
53+
- Reorganized output directory structure
54+
- Renamed charging tags during transfer (ML→CL, MM→CM)
55+
- Updated model download strategy
56+
- Increased memory allocation for modkit rules
57+
58+
### Fixed
59+
- Restored `-v` option in dorado for proper verbosity control
60+
61+
## [0.3.0] - 2025-01-08
62+
63+
### Added
64+
- Rule for calculating CPM of charged/uncharged tRNAs (#28)
65+
- Remora CCA classifier for charging state classification (#18)
66+
- GPU pipeline support for `cca_classify` rule (#23)
67+
- Charging probability extraction and analysis (#46)
68+
69+
### Changed
70+
- Implemented ML threshold (≥200 = charged, <200 = uncharged)
71+
- Compressed output files for storage efficiency
72+
- Various tweaks to file handling (#27)
73+
74+
### Fixed
75+
- Actually use the threshold value in classification
76+
77+
## [0.2.0] - 2024-08-13
78+
79+
### Added
80+
- Alignment filtering capabilities with configurable parameters (#13)
81+
- Optional Remora signal metrics extraction
82+
- Kmer models included in pipeline
83+
- Logging and optional failed BAM outputs
84+
- New BAM tag indicating why reads are filtered
85+
- Support for processing reads from both pass and fail directories
86+
87+
### Changed
88+
- Cleanup filtering approach for full-length tRNA reads
89+
- Updated test data
90+
- Ignore supplementary and secondary alignments
91+
- Snakemake v8 compatibility (#10)
92+
93+
### Fixed
94+
- Insertion double-counting bug (#15)
95+
- Dropped redundant summary align stats (#14)
96+
- Added 'pod5' to list of possible pod5 directories
97+
98+
## [0.1.0] - 2024-05-19
99+
100+
### Added
101+
- Support for merging multiple sequencing runs per sample
102+
- Support for unmapped BAM as input (#5)
103+
- Pipeline commit and config recording for reproducibility (#9)
104+
- Bedgraph output generation
105+
- Alignment statistics calculations
106+
- Base calling error frequency calculations
107+
108+
### Changed
109+
- Use v5.0.0 dorado models with modification calling
110+
- Expose dorado and bwa command-line options
111+
- Reworked alignment stats output (#8)
112+
- Set rebasecalled outputs as read-only
113+
114+
### Fixed
115+
- Keep additional BAM flags (e.g., pi) during processing (#1)
116+
- Use -T → -C options to preserve all BAM tags from dorado
117+
118+
## [0.0.1] - 2024-02-07
119+
120+
### Added
121+
- Initial pipeline release
122+
- Core workflow: POD5 merge → rebasecall → align → filter
123+
- BWA MEM alignment to tRNA + adapter reference
124+
- Post-alignment filtering for full-length tRNAs
125+
- Basic summary statistics generation
126+
- Snakemake workflow with modular rule structure
127+
- Conda environment specification
128+
- Sample configuration via TSV files

0 commit comments

Comments
 (0)