Skip to content

Commit 120195d

Browse files
committed
.
1 parent d166451 commit 120195d

24 files changed

Lines changed: 1092 additions & 85 deletions

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,33 @@ Use **[`params_POD5.yaml`](params_POD5.yaml)**.
9090
| `Host` | Optional: host depletion (e.g., `human,pan`). |
9191
| `virasign_ultrasensitive` | Optional: enable ultrasensitive viral identification mode. |
9292

93+
To autogenerate a [`POD5.csv`](nf-metatropics/assets/submission/POD5.csv) template, run **`pip install .`** once at the repo root, then **`metatropics-samplesheet pod5 -i .`** from your POD5 directory.
94+
95+
### fastq_pass start (on-device basecalled, demultiplex inside the pipeline)
96+
97+
Use **[`params_fastq_pass.yaml`](params_fastq_pass.yaml)**.
98+
99+
| Setting | Purpose |
100+
|-----|-------------------|
101+
| `input` | Copy **[`POD5.csv`](nf-metatropics/assets/submission/POD5.csv)** (same barcode mapping as POD5 mode), edit it, then set `input` to that file’s absolute path. |
102+
| `input_dir` | Directory with combined basecalled reads (e.g. `fastq_pass`). |
103+
| `outdir` | Where results are written. |
104+
| `basecall` | Must be `false` so the pipeline skips Dorado basecalling and only demultiplexes. |
105+
| `kit_name` | Dorado `--kit-name` (default: `TWIST-96A-UDI`). |
106+
| `Host` | Optional: host depletion (e.g., `human,pan`). |
107+
| `virasign_ultrasensitive` | Optional: enable ultrasensitive viral identification mode. |
108+
109+
Use the same **`metatropics-samplesheet pod5 -i .`** command from your `fastq_pass` folder to create a `POD5.csv` template there.
110+
93111
Additional options: **[`nf-metatropics/assets/submission/all_options.md`](nf-metatropics/assets/submission/all_options.md)**.
94112

95113
---
96114

97115
## 5. Running Metatropics
98116

99-
With your `params_fastq.yaml` or `params_POD5.yaml` in place, run from the repository root (swap `-profile docker` for e.g. `-profile singularity`, if needed):
117+
With your params file in place, run from the repository root (swap `-profile docker` for e.g. `-profile singularity`, if needed):
100118

101-
```
119+
```bash
102120
nextflow run nf-metatropics/ -profile docker -params-file params_fastq.yaml -resume
103121
```
104122

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""Samplesheet helpers for the Metatropics Nextflow pipeline (``metatropics-samplesheet``)."""
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
from .samplesheet import main
2+
3+
if __name__ == "__main__":
4+
main()

0 commit comments

Comments
 (0)