From b45ebdb43be717230c93239c4642bcdff68fc0fb Mon Sep 17 00:00:00 2001 From: Hasindu Gamaarachchi Date: Wed, 20 Dec 2023 15:57:44 +1100 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39501883..98314040 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ f5c eventalign -b [reads.sorted.bam] -g [ref.fa] -r [reads.fastq|fasta] --rna > f5c eventalign -b [reads.sorted.bam] -g [ref.fa] -r [reads.fastq|fasta] --pore r10 > [events.tsv] ``` -Visit the [man page](https://hasindu2008.github.io/f5c/docs/commands) for all the commands and options. +Visit the [man page](https://hasindu2008.github.io/f5c/docs/commands) for all the commands and options. See [here](https://hasindu2008.github.io/f5c/docs/output) for description of output formats. ### Example @@ -166,6 +166,8 @@ f5c eventalign -b chr22_meth_example/reads.sorted.bam -g chr22_meth_example/huma ``` +More examples can be found [here](https://hasindu2008.github.io/f5c/docs/example-usage). + ## Acknowledgement This reuses code and methods from [Nanopolish](https://github.com/jts/nanopolish). The event detection code is from Oxford Nanopore's [Scrappie basecaller](https://github.com/nanoporetech/scrappie).