Skip to content

Commit d55740c

Browse files
committed
fix: update changelog and README to reflect changes in FAST5 to POD5 conversion and directory structure
1 parent dd5bba4 commit d55740c

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## [1.1.0] - 2025-11-12
5+
## [1.1.0] - 2025-12-08
66

77
### Added
88

9+
- Automatically detects and converts FAST5 files to POD5 format if needed before basecalling.
910
- Haplotype-specific methylation analysis workflow
1011
- New `SPLIT_BAM` module to split haplotagged BAM files by haplotype (HP1, HP2, untagged)
1112
- Optional region-based filtering using BED file (`--regions_bed` parameter)

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ A Nextflow DSL2 pipeline for processing Oxford Nanopore long-read sequencing dat
2121

2222
```csv
2323
sampleid,data_dir
24-
sample1,/path/to/sample1
25-
sample2,/path/to/sample2
24+
sample1,/path/to/sample1/pod5/
25+
sample2,/path/to/sample2/pod5/
2626
```
2727

28-
**Note:** The pipeline expects a `pod5/` subdirectory within each `data_dir`. Your directory structure should look like:
28+
**Note:** The pipeline expects the full path of the directory containing the `*.pod5` or `*.fast5` files. Your directory structure should look like:
2929

3030
```text
3131
/path/to/sample1/
@@ -35,6 +35,14 @@ A Nextflow DSL2 pipeline for processing Oxford Nanopore long-read sequencing dat
3535
└── ...
3636
```
3737

38+
```text
39+
/path/to/sample1/
40+
└── fast5/
41+
├── file1.fast5
42+
├── file2.fast5
43+
└── ...
44+
```
45+
3846
2. **Target regions** (BED)
3947

4048
```tsv
@@ -76,6 +84,7 @@ The pipeline consists of the following main steps:
7684
1. **Basecalling** (`ONT_BASECALL`):
7785

7886
- Performs basecalling and modified base detection using `Dorado`. The output BAM file contains MM (modification type) and ML (modification likelihood) tags.
87+
- Automatically detects and converts FAST5 files to POD5 format if needed before basecalling.
7988
- Output: Unaligned BAM with methylation tags.
8089

8190
2. **Alignment** (`ALIGNMENT`):

0 commit comments

Comments
 (0)