Skip to content

Commit 7374e4b

Browse files
committed
more renames
1 parent 304e3aa commit 7374e4b

66 files changed

Lines changed: 840 additions & 840 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ jobs:
402402
run: |
403403
gh release create "${{ needs.check-release.outputs.version }}" \
404404
--target "${{ github.sha }}" \
405-
--title "ruSTAR ${{ needs.check-release.outputs.version }}" \
405+
--title "rustar-aligner ${{ needs.check-release.outputs.version }}" \
406406
--notes-file /tmp/release-notes.md
407407
408408
- name: Create release (auto-generated notes)
@@ -412,7 +412,7 @@ jobs:
412412
run: |
413413
gh release create "${{ needs.check-release.outputs.version }}" \
414414
--target "${{ github.sha }}" \
415-
--title "ruSTAR ${{ needs.check-release.outputs.version }}" \
415+
--title "rustar-aligner ${{ needs.check-release.outputs.version }}" \
416416
--generate-notes
417417
418418
# ------------------------------------------------------------------

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# ruSTAR Changelog
1+
# rustar-aligner Changelog
22

33
<!--
44
Release notes are extracted from this file by the release workflow.
55
Each released version needs a heading of the form:
66
7-
## [Version X.Y.Z](https://github.com/Psy-Fer/ruSTAR/releases/tag/vX.Y.Z) - YYYY-MM-DD
7+
## [Version X.Y.Z](https://github.com/Psy-Fer/rustar-aligner/releases/tag/vX.Y.Z) - YYYY-MM-DD
88
99
Sections commonly used: Features, Bug fixes, Other changes.
1010
-->

CLAUDE.md

Lines changed: 9 additions & 9 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to ruSTAR
1+
# Contributing to rustar-aligner
22

33
## Building and testing
44

@@ -20,7 +20,7 @@ Small synthetic and yeast test data lives in `test/`. Integration tests in `test
2020

2121
## Project history
2222

23-
ruSTAR was written as a faithful port of [STAR](https://github.com/alexdobin/STAR) by Alexander Dobin. Up to the initial release, the goal was behavioral parity with STAR — matching its algorithms, thresholds, and output formats as closely as possible. Notes from that development phase are in `docs/dev/`.
23+
rustar-aligner was written as a faithful port of [STAR](https://github.com/alexdobin/STAR) by Alexander Dobin. Up to the initial release, the goal was behavioral parity with STAR — matching its algorithms, thresholds, and output formats as closely as possible. Notes from that development phase are in `docs/dev/`.
2424

2525
Future development is not bound by that constraint. Adding STARsolo, new features, or diverging from STAR behavior is entirely welcome.
2626

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ rust-version = "1.88"
66
authors = ["James Ferguson"]
77
description = "A Rust reimplementation of STAR (Spliced Transcripts Alignment to a Reference), the RNA-seq aligner"
88
license = "MIT"
9-
repository = "https://github.com/Psy-Fer/ruSTAR"
9+
repository = "https://github.com/Psy-Fer/rustar-aligner"
1010
readme = "README.md"
1111
keywords = ["bioinformatics", "rna-seq", "aligner", "sequencing", "star"]
1212
categories = ["command-line-utilities", "science"]

Dockerfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ RUN HOST_TRIPLE=$(rustc -vV | awk '/^host:/ {print $2}') && \
1616
GIT_SHORT_HASH="${GIT_SHORT_HASH}" \
1717
cargo build --release --target "$HOST_TRIPLE" \
1818
${CPU_TARGET:+--config "target.'$HOST_TRIPLE'.rustflags=['-C', 'target-cpu=$CPU_TARGET']"} \
19-
&& strip "target/$HOST_TRIPLE/release/ruSTAR" \
20-
&& cp "target/$HOST_TRIPLE/release/ruSTAR" /ruSTAR
19+
&& strip "target/$HOST_TRIPLE/release/rustar-aligner" \
20+
&& cp "target/$HOST_TRIPLE/release/rustar-aligner" /rustar-aligner
2121

2222
# ---- Runtime stage ----
2323
FROM debian:bookworm-slim
@@ -27,7 +27,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
2727
procps \
2828
&& rm -rf /var/lib/apt/lists/*
2929

30-
COPY --from=builder /ruSTAR /usr/local/bin/ruSTAR
31-
COPY --from=builder /ruSTAR /usr/local/bin/STAR
30+
COPY --from=builder /rustar-aligner /usr/local/bin/rustar-aligner
31+
COPY --from=builder /rustar-aligner /usr/local/bin/STAR
3232

33-
CMD ["ruSTAR"]
33+
CMD ["rustar-aligner"]

ROADMAP.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ruSTAR Implementation Roadmap
1+
# rustar-aligner Implementation Roadmap
22

33
Tracks implementation progress across sessions. Each phase lists its deliverables, files touched, and completion status. Detailed notes for later phases are in `docs/`.
44

@@ -197,18 +197,18 @@ See [docs/phase16_algorithm.md](docs/phase16_algorithm.md) for sub-phase notes (
197197
| Fixable algorithm differences | 26 | 0.29% | Yes |
198198
| **Parity excl. unavoidable ties** | **8800/8826** | **99.70%** ||
199199

200-
**Adjusted SE summary (post Phase 16.29)**: 99.7% position agreement, 99.9% CIGAR, 2.2% splice rate (= STAR), 99.9% MAPQ, 26 actionable disagreements, 1 STAR-only / 1 ruSTAR-only. MAPQ inflation: 4 reads, MAPQ deflation: 4 reads.
200+
**Adjusted SE summary (post Phase 16.29)**: 99.7% position agreement, 99.9% CIGAR, 2.2% splice rate (= STAR), 99.9% MAPQ, 26 actionable disagreements, 1 STAR-only / 1 rustar-aligner-only. MAPQ inflation: 4 reads, MAPQ deflation: 4 reads.
201201

202202
**PE parity (10k yeast pairs, 150 bp, post Phase G2):**
203203

204-
| Metric | ruSTAR | STAR |
204+
| Metric | rustar-aligner | STAR |
205205
|--------|--------|------|
206206
| Both-mapped pairs | **8390** | 8390 |
207207
| Half-mapped pairs | **0** | 0 |
208208
| Net gap | **0 (exact match)** ||
209209
| PE faithfulness (tie-adj, pos+CIGAR+MAPQ+proper+NH) | **99.883%** (16,284/16,306) ||
210210
| Tie-breaking diffs (excluded) | 475 ||
211-
| ruSTAR-only false positives | 1 (`.6302610`) ||
211+
| rustar-aligner-only false positives | 1 (`.6302610`) ||
212212
| STAR-only missed | 1 (`.18919121`) ||
213213
| MAPQ inflations | **0** ||
214214
| MAPQ deflations | **0** ||
@@ -248,7 +248,7 @@ All 127 SE position disagreements (100 diff-chr + 27 same-chr) verified as **gen
248248
| Issue | Count | Difficulty |
249249
|-------|-------|------------|
250250
| SE CIGAR insertion placement | 1 | Hard — `ERR12389696.13573895` (AS=133 both, same pos, homopolymer seed-level tie) |
251-
| PE ruSTAR-only FP | 1 | `.6302610` — adapter contamination at mate2 pos 40, seeding-level |
251+
| PE rustar-aligner-only FP | 1 | `.6302610` — adapter contamination at mate2 pos 40, seeding-level |
252252
| PE STAR-only | 1 | `.18919121` — SA construction diff (EX_R=0 vs 1), SA-level |
253253
| PE AS diffs | 6 | Residual combined-score parity gaps |
254254

@@ -268,7 +268,7 @@ STAR ... 2>star_debug.log
268268

269269
Helper script: `test/debug_star.sh`
270270
```bash
271-
./debug_star.sh pe <rustar.sam> <star.sam> [n_reads] # extract & trace false positives
271+
./debug_star.sh pe <rustar-aligner.sam> <star.sam> [n_reads] # extract & trace false positives
272272
./debug_star.sh reads "read1,read2" # trace specific reads
273273
```
274274

docs/dev/ALIGNMENT_FIXES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
## Executive Summary
88

9-
Fixed critical bugs preventing alignments from working. ruSTAR now successfully aligns reads to the genome with valid SAM output, though performance and unique/multi classification need improvement.
9+
Fixed critical bugs preventing alignments from working. rustar-aligner now successfully aligns reads to the genome with valid SAM output, though performance and unique/multi classification need improvement.
1010

1111
### Test Results (Yeast, 100 reads)
1212

13-
| Metric | STAR | ruSTAR | Status |
13+
| Metric | STAR | rustar-aligner | Status |
1414
|--------|------|--------|--------|
1515
| Time | <0.1s | ~5s | ⚠️ 50x slower |
1616
| Uniquely mapped | 88% | 0% | ⚠️ Classification broken |
@@ -215,7 +215,7 @@ if alignment_end < read_seq.len() {
215215

216216
**Profiling Needed**:
217217
```bash
218-
perf record -g ./target/release/ruSTAR --runMode alignReads ...
218+
perf record -g ./target/release/rustar-aligner --runMode alignReads ...
219219
perf report
220220
```
221221

@@ -239,7 +239,7 @@ perf report
239239
### Working Test (100 reads):
240240
```bash
241241
cd test/data/small/yeast
242-
ruSTAR --runMode alignReads \
242+
rustar-aligner --runMode alignReads \
243243
--genomeDir indices_rustar \
244244
--readFilesIn reads/ERR12389696_sub_1_100.fastq.gz \
245245
--readFilesCommand zcat \

docs/dev/BUGFIX_2026-02-09.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Always try to merge with previous Match operation before pushing new one:
100100
- **Root Cause:** Internal representation uses global genome coordinates (cumulative across all chromosomes), but SAM/SJ format requires per-chromosome coordinates
101101

102102
### Coordinate Systems
103-
**Internal (ruSTAR):**
103+
**Internal (rustar-aligner):**
104104
- Global genome coordinates: cumulative across all chromosomes
105105
- Example: chr1 [0, 100k), chr2 [100k, 300k), chr3 [300k, 450k)
106106
- Position 350k → chr3, position 50k within chr3
@@ -212,7 +212,7 @@ if negative_value < 0 {
212212

213213
### 2. Coordinate System Documentation is Critical
214214
Internal representation vs external format:
215-
- **Internal:** Whatever is most efficient (global coords for ruSTAR)
215+
- **Internal:** Whatever is most efficient (global coords for rustar-aligner)
216216
- **External:** Whatever the standard requires (per-chr for SAM/BAM)
217217
- **Critical:** Convert at I/O boundaries
218218

@@ -244,7 +244,7 @@ cargo build --release
244244
cargo test # 170/170 passing
245245

246246
# Test 100 reads
247-
./target/release/ruSTAR \
247+
./target/release/rustar-aligner \
248248
--runMode alignReads \
249249
--genomeDir test/data/small/yeast/indices_rustar \
250250
--readFilesIn test/data/small/yeast/reads/ERR12389696_sub_1_100.fastq.gz \

docs/dev/PHASE12_COMPLETE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Phase 12 is now fully functional for single-end reads!
5151

5252
Enable chimeric detection with:
5353
```bash
54-
./target/release/ruSTAR \
54+
./target/release/rustar-aligner \
5555
--runMode alignReads \
5656
--genomeDir /path/to/index \
5757
--readFilesIn reads.fq \

0 commit comments

Comments
 (0)