TeloVision is a python package which determines the presence of telomeres in genome assembly scaffolds. Subsequently the scaffolds are visualised along with their GC content. Telomeres will be visualised as black boxes at the ends of scaffolds, while the absence of telomeres will be indicated by a white box at the end of scaffolds.
Python >3.10 is required for installation!
TeloVision can be installed by first cloning this GitHub repository. Subsequently, go into the location where the repository was saved and use pip to install the package.
# Clone repository
git clone https://github.com/WesterdijkInstitute/TeloVision.git
# Go into repository location
cd .../TeloVision/
# Install package with pip
pip install .TeloVision has 2 required inputs and 5 optional ones. An input and output file are required, while the k-mer size, minimum repeat length, sequence size, gap-size and sorting parameters can be altered if the user wishes so. If the optional inputs are not selected, default values will be used.
usage: telovision [-h] -i INPUT -o OUTPUT [-k KMER_SIZE] [-r MIN_REPEAT_LENGTH] [-s SEQUENCE_SIZE] [-g GAP_SIZE] [--sorted]
TeloVision - Determine and visualise the presence of telomeres. For more information see: https://github.com/TimVerschuren/TeloVision
options:
-h, --help show this help message and exit
-i INPUT, --input INPUT
Location of fasta file
-o OUTPUT, --output OUTPUT
Name of output file
-k KMER_SIZE, --kmer_size KMER_SIZE
Size of k-mer sliding window. (default: 5000)
-r MIN_REPEAT_LENGTH, --min_repeat_length MIN_REPEAT_LENGTH
Minimum length for a repetitive region to be counted as a telomere. (default: 30)
-s SEQUENCE_SIZE, --sequence_size SEQUENCE_SIZE
Size of sequence taken from the 5' and 3' ends of the sequence for analysis. (default: 200)
-g GAP_SIZE, --gap_size GAP_SIZE
Size of gaps allowed within telomeric repeats. (default: length of detected repeat)
--sorted Sorts the scaffolds by size if selected.
| Repeat | Length | GC% | Telomere | Repetitive Sequence | |
|---|---|---|---|---|---|
| chr_101_5' | AAAACCCT | 128 | 0.375 | Y | AAAACCCTAAAACCCTAAAACCCTAAAACCCTAAAACCCTAAAACCCTAAAAACCCTAAACCCTAAAACCCTAAAACCCTAAAACCCTAAAACCCTAAAAACCCTAAAACCCTAAAACCCTAAACCCT |
| chr_101_3' | TAATAATAAAAT | 60 | 0.0 | N | TAATAATAAAATTAATAATAAAATTAATAATAAAATTAATAATAAAATTAATAATAAAAT |
| chr_102_5' | TAATA | 10 | 0.0 | N | TAATATAATA |
| chr_102_3' | TTAGGGTT | 48 | 0.375 | Y | TTAGGGTTTTAGGGTTTTAGGGTTTTAGGGTTTTAGGGTTTTAGGGTT |
| ... |