Skip to content

Commit 0450c6b

Browse files
committed
Update CHANGELOG
1 parent 0125a8c commit 0450c6b

File tree

1 file changed

+50
-17
lines changed

1 file changed

+50
-17
lines changed

CHANGELOG.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,58 @@
22

33
## 25-258 (v0.2.0)
44

5-
This release introduces significant changes to the pipeline.
5+
**First public release.**
6+
This version introduces major structural updates, improved performance, and clearer input handling.
67

7-
* New step: CONCAT_FASTQS
8-
#### ➤ Improvements
9-
- Input style has been modified.
8+
### 🚀 New
109

11-
#### ➤ Major Workflow & Script Changes
12-
**FIND_LARRY_SEQS**
13-
- Minor change on underlying CBUtools package and the Dockerfile allows parallelisation and significantly speeds up this process (more than 4x)
10+
* **New step: `CONCAT_FASTQS`**
11+
Collapses lane-split FASTQs into single R1/R2 files per sample.
1412

15-
**LARRY_QC**
16-
- Added more logging before each filter
17-
- Fixed QC plots and text in PDF report
18-
- Changed whitelist directory to the repository directory
13+
* Skips samples that already have a single pair.
14+
* Standardizes naming for clean downstream matching.
1915

20-
**ASSIGN_CLONES → ASSIGN_BARCODES**
21-
- Changed the step name for clarity.
22-
- Refactored to support new input structure
16+
### ✨ Improvements
17+
18+
* **Inputs & Groups**
19+
20+
* Restructured input style: added clearer **group ID** handling in sample maps.
21+
* Whitelist CSV is now stored directly in the repository.
22+
23+
* **FIND\_LARRY\_SEQS**
24+
25+
* Underlying `CBUtools` and Dockerfile changes enable **parallelisation**, yielding **>4× faster runtime**.
26+
27+
* **LARRY\_QC**
28+
29+
* Added more logging between filters for transparency.
30+
* Fixed QC plots and text in the PDF report.
31+
* Whitelist directory now defaults to the repo path.
32+
33+
* **ASSIGN\_BARCODES** *(formerly `ASSIGN_CLONES`)*
34+
35+
* Renamed for clarity and consistency with the poster/README.
36+
* Refactored to support the new input structure.
37+
* Removed `combine_samples` functionality (now handled via group IDs).
38+
39+
* **MATCH\_GEX**
40+
41+
* Added **support for Cell Ranger outputs** (in addition to STARsolo).
42+
* Refactored to support the new input structure.
43+
44+
### 🛠 Internal
45+
46+
* Updated Dockerfile: streamlined how `CBUtools` is installed and used.
47+
* Modified process resources and updated Singularity image.
48+
* Cleaned up example files/scripts.
49+
* Removed old git submodule.
50+
51+
---
52+
53+
## (v0.1.0) *(Internal only)*
54+
55+
Prototype version used internally before public release.
56+
57+
* Core workflow with steps: `FIND_LARRY_SEQS`, `LARRY_QC`, `ASSIGN_CLONES`, `MATCH_GEX`.
58+
* Added early prototype workflow: `until_clones`.
2359

24-
**MATCH_GEX**
25-
- Added support for Cell Ranger outputs.
26-
- Refactored to support new input structure

0 commit comments

Comments
 (0)