annotate dante.xml @ 4:6a92134a105b draft

Uploaded
author petr-novak
date Wed, 03 Jul 2019 05:29:51 -0400
parents 18d6c1c66798
children 6dcecbe81d78
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
1 <tool id="dante" name="Domain based ANnotation of Transposable Elements - DANTE" version="1.0.0">
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
2 <description> Tool for annotation of transposable elements based on the similarity to conserved protein domains database. </description>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
3 <requirements>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
4 <requirement type="package">last</requirement>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
5 <requirement type="package">numpy</requirement>
3
18d6c1c66798 Uploaded
petr-novak
parents: 0
diff changeset
6 <requirement type="package" version="1.0">rexdb</requirement>
0
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
7 </requirements>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
8 <stdio>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
9 <regex match="Traceback" source="stderr" level="fatal" description="Unknown error" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
10 <regex match="error" source="stderr" level="fatal" description="Unknown error" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
11 </stdio>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
12 <command>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
13 python3 ${__tool_directory__}/dante.py --query ${input} --domain_gff ${DomGff}
3
18d6c1c66798 Uploaded
petr-novak
parents: 0
diff changeset
14 --protein_database \${REXDB}/${db_type}_pdb
0
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
15 --classification ${__tool_directory__ }/tool-data/protein_domains/${db_type}_class
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
16 </command>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
17 <inputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
18 <param format="fasta" type="data" name="input" label="Choose your input sequence" help="Input DNA must be in proper fasta format, multi-fasta containing more sequences is allowed" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
19
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
20 <param name="db_type" type="select" label="Select taxon and protein domain database version (REXdb)" help="">
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
21 <options from_file="rexdb_versions.loc">
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
22 <column name="name" index="0"/>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
23 <column name="value" index="1"/>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
24 </options>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
25 </param>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
26 </inputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
27
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
28 <outputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
29 <data format="gff3" name="DomGff" label="Unfiltered GFF3 file of ALL protein domains from dataset ${input.hid}" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
30 </outputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
31 <help>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
32
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
33 THIS IS A PRIMARY OUTPUT THAT SHOULD UNDERGO FURTHER QUALITY FILTERING TO GET RID OFF POTENTIAL FALSE POSITIVE DOMAINS
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
34
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
35 **WHAT IT DOES**
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
36
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
37 This tool uses external aligning programme `LAST`_ and RepeatExplorer database of TE protein domains(REXdb) (Viridiplantae and Metazoa)
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
38
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
39 .. _LAST: http://last.cbrc.jp/
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
40
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
41 *Lastal* runs similarity search to find hits between query DNA sequence and our database of protein domains from all Viridiplantae repetitive elements. Hits with overlapping positions in the sequence (even through other hits) forms a cluster which represents one potential protein domain. Strand orientation is taken into consideration when forming the clusters which means each cluster is built from forward or reverse stranded hits exclusively. The clusters are subsequently processed separately; within one cluster positions are scanned base-by-base and classification strings are assigned for each of them based on the database sequences which were mapped on that place. These asigned classification strings consist of a domain type as well as class and lineage of the repetitive element where the database protein comes from. Different classification levels are separated by "|" character. Every hit is scored according to the scoring matrix used for DNA-protein alignment (BLOSUM80). For single position only the hits reaching certain percentage (80% by default) of the overall best score within the whole cluster are reported. One cluster of overlapping hits represents one domain region and is recorded as one line in the resulting GFF3 file. Regarding the classition strings assigned to one region (cluster) there are three situations that can occur:
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
42
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
43 1. There is a single classification string assigned to each position as well as classifications along all the positions in the region are mutually uniform, in this case domain's final classification is equivalent to this unique classification.
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
44 2. There are multiple classification strings assigned to one cluster, i.e. one domain, which leads to classification to the common (less specific) level of all the strings
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
45 3. There is a conflict at the domain type level, domains are reported with slash (e.g. RT/INT) and the classification is in this case ambiguous
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
46
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
47 **There are 2 outputs produced by this tool:**
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
48
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
49 1. GFF3 file of all proteins domains built from all hits found by LAST. Domains are reported per line as regions (start - end) on the original DNA sequence including the seq ID, alignment score and strand orientation. The last "Attributes" column contains several semicolon-separated information related to annotation, repetitive classification, alignment and its quality. This file can undergo further filtering using *Protein Domain Filter* tool
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
50
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
51 - Attributes reported always:
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
52
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
53 Name
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
54 type of domain; if ambiguous reported with slash
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
55
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
56 Final_classification
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
57 definite classification based on all partial classifications of Region_hits_classifications attribute or
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
58 "Ambiguous_domain" when there is an ambiguous domain type
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
59
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
60 Region_Hits_Classifications
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
61 all hits classifications (comma separated) from a certain domain region that reach the set score threshold; in case of multiple annotations the square brackets indicate the number of bases having this particular classification
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
62
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
63 - Attributes only reported in case of unambiguous domain type (all the attributes including quality information are related to the Best_Hit of the region):
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
64
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
65 Best_hit
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
66 classification and position of the best alignment with the highest score within the cluster; in the square brackets is the percentage of the whole cluster range that this best hit covers
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
67
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
68 Best_Hit_DB_Pos
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
69 showing which part of the original datatabase domain corresponding to the Best Hit was aligned on query DNA (e.g. **Best_Hit_DB_Pos=17:75of79** means the Best Hit reported in GFF represents region from 17th to 75th of total 79 aminoacids in the original domain from the database)
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
70
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
71 DB_Seq
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
72 database protein sequence of the best hit mapped to the query DNA
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
73
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
74 Query_Seq
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
75 alignment sequence of the query DNA for the best hit
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
76
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
77 Identity
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
78 ratio of identical amino acids in alignment sequence to the length of alignment
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
79
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
80 Similarity
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
81 ratio of alignment positions with positive score (according to the scoring matrix) to the length of alignment
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
82
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
83 Relat_Length
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
84 ratio of gapless length of the aligned protein sequence to the whole length of the database protein
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
85
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
86 Relat_Interruptions
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
87 number of the interruptions (frameshifts + stop codons) in aligned translated query sequence per each starting 100 AA
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
88
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
89 Hit_to_DB_Length
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
90 proportion of alignment length to the original length of the protein domain from database
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
91
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
92
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
93
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
94 !NOTE: Tool can in average process 0.5 Gbps of the DNA sequence per day. This is only a rough estimate and it is highly dependent on input data (repetive elements occurence) as well as computing resources. Maximum running time of the tool is 7 days.
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
95
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
96 </help>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
97 </tool>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
98