Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AldhairMedico authored Oct 18, 2024
1 parent 7249f56 commit ed7394d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
If you use **Teloscope**, please, cite the current repository.

0 comments on commit ed7394d

Please sign in to comment.