Skip to content

Commit 304e3aa

Browse files
committed
update README for name change
1 parent 2b54b53 commit 304e3aa

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

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

33
A Rust reimplementation of [STAR](https://github.com/alexdobin/STAR) (Spliced Transcripts Alignment to a Reference), the widely-used RNA-seq aligner originally written in C++ by Alexander Dobin.
44

55
## Overview
66

7-
ruSTAR aims to be a faithful port of STAR, matching the original behavior as closely as possible. It uses the same genome index format, accepts the same `--camelCase` command-line parameters, and produces compatible SAM/BAM output.
7+
rustar-aligner aims to be a faithful port of STAR, matching the original behavior as closely as possible. It uses the same genome index format, accepts the same `--camelCase` command-line parameters, and produces compatible SAM/BAM output.
88

99
**Current status**: End-to-end single-end and paired-end RNA-seq alignment with splice junction detection, two-pass mode, chimeric alignment detection (including multi-junction Tier 3), gene-level quantification, and multi-threaded parallel processing. 396 tests passing (383 unit + 8 integration + others), 0 clippy warnings.
1010

@@ -19,15 +19,15 @@ cargo build --release
1919
### Generate genome index
2020

2121
```bash
22-
target/release/ruSTAR --runMode genomeGenerate \
22+
target/release/rustar-aligner --runMode genomeGenerate \
2323
--genomeDir /path/to/genome_index \
2424
--genomeFastaFiles /path/to/genome.fa
2525
```
2626

2727
### Align reads
2828

2929
```bash
30-
target/release/ruSTAR \
30+
target/release/rustar-aligner \
3131
--genomeDir /path/to/genome_index \
3232
--readFilesIn reads.fq \
3333
--outSAMtype SAM \
@@ -38,7 +38,7 @@ target/release/ruSTAR \
3838
### Paired-end alignment
3939

4040
```bash
41-
target/release/ruSTAR \
41+
target/release/rustar-aligner \
4242
--genomeDir /path/to/genome_index \
4343
--readFilesIn reads_1.fq reads_2.fq \
4444
--outSAMtype SAM \
@@ -48,7 +48,7 @@ target/release/ruSTAR \
4848
### BAM output
4949

5050
```bash
51-
target/release/ruSTAR \
51+
target/release/rustar-aligner \
5252
--genomeDir /path/to/genome_index \
5353
--readFilesIn reads.fq \
5454
--outSAMtype BAM Unsorted \
@@ -58,7 +58,7 @@ target/release/ruSTAR \
5858
### Coordinate-sorted BAM output
5959

6060
```bash
61-
target/release/ruSTAR \
61+
target/release/rustar-aligner \
6262
--genomeDir /path/to/genome_index \
6363
--readFilesIn reads.fq \
6464
--outSAMtype BAM SortedByCoordinate \
@@ -68,7 +68,7 @@ target/release/ruSTAR \
6868
### Two-pass mode
6969

7070
```bash
71-
target/release/ruSTAR \
71+
target/release/rustar-aligner \
7272
--genomeDir /path/to/genome_index \
7373
--readFilesIn reads.fq \
7474
--twopassMode Basic \
@@ -78,7 +78,7 @@ target/release/ruSTAR \
7878
### Gene-level counts
7979

8080
```bash
81-
target/release/ruSTAR \
81+
target/release/rustar-aligner \
8282
--genomeDir /path/to/genome_index \
8383
--readFilesIn reads.fq \
8484
--sjdbGTFfile /path/to/annotation.gtf \
@@ -92,22 +92,22 @@ Benchmarked on 10,000 yeast RNA-seq reads (150 bp, ERR12389696), compared to STA
9292

9393
### Single-End (10k reads, 150 bp SE)
9494

95-
| Metric | ruSTAR | STAR |
96-
|--------|--------|------|
95+
| Metric | rustar-aligner | STAR |
96+
|--------|----------------|------|
9797
| Unique mapped | 82.6% | 82.6% |
9898
| Multi-mapped | 7.4% | 7.4% |
9999
| Total mapped | 90.0% | 90.0% |
100100
| Position agreement | 96.5% raw / **99.815% tie-adjusted** ||
101101
| STAR-only reads | **0** ||
102-
| ruSTAR-only reads | **0** ||
102+
| rustar-aligner-only reads | **0** ||
103103
| CIGAR-only diffs | 1 (seed-level tie in homopolymer) ||
104104

105105
> **Tie-adjusted**: 299 of 313 disagreements are verified genuine ties — both tools find identical alignment sets but select different copies due to SA-order or RNG tie-breaking differences. Excluding these, faithfulness is 99.815% (8,611/8,627 non-tie reads exact).
106106
107107
### Paired-End (10k read pairs, 150 bp)
108108

109-
| Metric | ruSTAR | STAR |
110-
|--------|--------|------|
109+
| Metric | rustar-aligner | STAR |
110+
|--------|----------------|------|
111111
| Both mates mapped | **8,390** | 8,390 |
112112
| Half-mapped pairs | **0** | 0 |
113113
| Unmapped pairs | 0 | 0 |
@@ -163,7 +163,7 @@ cargo fmt # Format
163163

164164
## Development
165165

166-
The majority of ruSTAR's code was written by [Claude Code](https://claude.ai/code) (Anthropic's AI coding assistant), with technical direction, architecture decisions, and validation by the project maintainer.
166+
The majority of rustar-aligner's code was written by [Claude Code](https://claude.ai/code) (Anthropic's AI coding assistant), with technical direction, architecture decisions, and validation by the project maintainer.
167167

168168
## License
169169

0 commit comments

Comments
 (0)