Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dialvarezs committed Sep 5, 2024
1 parent 66b9bfc commit 46bfeab
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ONT Basecalling / Demux Pipeline

Small pipeline to perform basecalling and (optional) demultiplexing of ONT data, collect QC metrics and generate a MultiQC report.
Nextflow pipeline to perform basecalling and (optional) demultiplexing of ONT data, collect QC metrics and generate a MultiQC report.
Uses Dorado for basecalling and demultiplexing.

## Requirements
Expand Down Expand Up @@ -35,7 +35,7 @@ Uses Dorado for basecalling and demultiplexing.
| `experiment_name` | No | - | Name of the experiment, used for final reports (title and filename). |
| `data_dir` | Yes | - | Path to the directory containing POD5 files. |
| `sample_data` | No | - | Path to the CSV file containing the sample data (if not provided, will not perform demux). |
| `output_dir` | No | `demultiplex_results` | Directory for saving results. |
| `output_dir` | No | `results` | Directory for saving results. |
| `fastq_output` | No | `true` | Generates FASTQ files if `true`; otherwise, generates UBAM files. |
| `qscore_filter` | No | `10` | Minimum QScore threshold for "pass" data, used in demultiplexing. |
| `dorado_basecalling_model` | No | `sup` | Model used for basecalling. Check Dorado help for available options. |
Expand Down

0 comments on commit 46bfeab

Please sign in to comment.