diff --git a/README.md b/README.md index 3e992af..15b0596 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Teloscope A telomere annotation tool. -Teloscope is a fast and comprehensive tool for matching, counting and reporting telomeric pattens from genome assemblies (.fa) or (.fa.gz). Teloscope allows the calculation of other metrics such as: +Teloscope is a fast and comprehensive tool for matching, counting, and reporting telomeric repeats from genome assemblies (.fa) or (.fa.gz). Teloscope outputs telomere block annotations in BED files. It also allows the calculation of metrics such as: * GC * Shannon Entropy @@ -14,17 +14,17 @@ Either download one of the releases or `git clone https://github.com/vgl-hub/tel ## Usage -`teloscope -f input.[fasta][.gz] -o [output/dir] -p TTAGGG,TTAGGGG -w [window size] -s [step size] -k` +`teloscope -f input.[fasta][.gz] -o [output/dir] -c TTAGGG -p TTAGGG,TCAGGG,TGAGGG -w [window size] -s [step size] -k` To check out all options and flags, please use: `teloscope -h` -**Note:** Teloscope automatically explores for the input patterns and their reverse complements. If none are provided, it will scan for the canonical CCCTAA/TTAGGG repeats. +**Note:** Teloscope automatically explores the input repeats and their reverse complements. If none are provided, it will scan for the canonical CCCTAA/TTAGGG repeats. ## Description -Briefly, **Teloscope** reads any assembly and decompose its parts. It uses prefix trees and sliding windows to match and count telomeric patterns efficiently. It also analyzes the informational properties of the assembly to distinguish canonical and non-canonical telomere repeats. +Briefly, **Teloscope** reads an assembly and decomposes its parts. It uses prefix trees and sliding windows to match and count telomeric repeats efficiently. It also analyzes the informational properties of the assembly to distinguish canonical and non-canonical telomere repeats. ## How to cite -If you use **Teloscope**, please cite the current repository. \ No newline at end of file +If you use **Teloscope**, please, cite the current repository.