annotate dante_gff_output_filtering.xml @ 16:0e820310d4dc draft

Uploaded
author petr-novak
date Wed, 04 Sep 2019 06:45:18 -0400
parents d0431a839606
children 1eabd42e00ef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
1 <tool id="domains_filter" name="Protein Domains Filter" version="1.0.0">
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
2 <description> Tool for filtering of gff3 output from DANTE. Filtering can be performed based domain type and alignment quality. </description>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
3 <stdio>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
4 <regex match="Traceback" source="stderr" level="fatal" description="Unknown error" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
5 <regex match="error" source="stderr" level="fatal" description="Unknown error" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
6 </stdio>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
7 <command>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
8 python3 ${__tool_directory__}/dante_gff_output_filtering.py --dom_gff ${DomGff} --domains_prot_seq ${dom_prot_seq} --domains_filtered ${dom_filtered} --selected_dom ${selected_domain} --th_identity ${th_identity} --th_similarity ${th_similarity} --th_length ${th_length} --interruptions ${interruptions} --max_len_proportion ${th_len_ratio} --element_type '${element_type}'
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
9
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
10 </command>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
11 <inputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
12 <param format="gff" type="data" name="DomGff" label="Choose primary GFF3 file of all domains from Protein Domains Finder" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
13 <param name="th_identity" type="float" value="0.35" min="0" max="1" label="Minimum identity" help="Protein sequence indentity threshold between input and mapped protein from db [0-1]" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
14 <param name="th_similarity" type="float" value="0.45" min="0" max="1" label="Minimum similarity" help="Protein sequence similarity threshold between input and mapped protein from db [0-1]" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
15 <param name="th_length" type="float" value="0.8" min="0" max="1" label="Minimum alignment length" help="Proportion of the hit length without gaps to the length of the database sequence [0-1]" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
16 <param name="interruptions" type="integer" value="3" label="Interruptions [frameshifts + stop codons]" help="Tolerance threshold per every starting 100 amino acids of alignment sequence" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
17 <param name="th_len_ratio" type="float" value="1.2" label="Maximal length proportion" help="Maximal proportion of alignment length to the original length of protein domain from database (including indels)" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
18 <param name="selected_domain" type="select" label="Select protein domain type" >
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
19 <options from_file="select_domain.loc" >
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
20 <column name="name" index="0"/>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
21 <column name="value" index="0"/>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
22 </options>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
23 </param>
10
d0431a839606 Uploaded
petr-novak
parents: 0
diff changeset
24 <param name="element_type" type="text" value="" label="Filter based on classification" help="You can use preset options or enter an arbitrary string to filter a certain repetitive element type of any level. It must be a continuous substring in a proper format of Final_Classification attribute of GFF3 file. Classification levels are separated by | character. Filtering is case sensitive">
0
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
25 <option value="Ty1/copia">Ty1/copia</option>
10
d0431a839606 Uploaded
petr-novak
parents: 0
diff changeset
26 <option value="Ty3/gypsy">Ty3/gypsy</option>
0
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
27 <option value="Class_I|">Class_I|</option>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
28 <option value="Class_II|">Class_II|</option>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
29 <sanitizer>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
30 <valid initial="string.ascii_letters,string.digits">
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
31 <add value="_" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
32 <add value="/" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
33 <add value="|" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
34 </valid>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
35 </sanitizer>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
36 </param>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
37 </inputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
38 <outputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
39 <data format="gff3" name="dom_filtered" label="Filtered GFF3 file of ${selected_domain} domains from dataset ${DomGff.hid}" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
40 <data format="fasta" name="dom_prot_seq" label="Protein sequences of ${selected_domain} domains from dataset ${DomGff.hid}" />
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
41
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
42
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
43 </outputs>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
44
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
45 <help>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
46
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
47 **WHAT IT DOES**
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
48
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
49 This tool runs filtering on either primary GFF3 file of all domains, i.e. output of *Protein Domains Finder* tool or already filtered GFF3 file. Domains can be filtered based on:
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
50
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
51 **Quality of alignment such as**:
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
52 - alignment sequence identity
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
53 - alignment similarity
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
54 - alignment proportion length
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
55 - number of interruptions (frameshifts or stop codons) per 100 AA
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
56
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
57 **Protein domain type**
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
58 This filtration is based on "Name" attribute of GFF3 file
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
59
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
60 **Repetitive element classification**
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
61 In the text field you can specify a classification string you wish to filter. This filtration is based on "Final_Classification" attribute of GFF file, so it must be in the proper form (classification levels are separated by "|"). You can see which classifications occurs in your data taking a look into Classification summary table output. If you leave the field blank, domains of all classifications will be reported
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
62
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
63 All the records containing ambiguous domain type (e.g. RH/INT) are filtered out automatically. They do not take place in filtered gff file neither the protein sequence is derived from these potentially chimeric domains. Optimal results (for general usage) should be reached using the default quality filtering parameters which are appropriate to find all types of protein domains. Keep in mind that the results should be critically assessed based on your input data anyhow.
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
64
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
65
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
66 **OUTPUTS PRODUCED:**
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
67 1. Filtered GFF3 file
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
68 2. Translated protein sequences of the filtered domains regions of original DNA sequence in fasta format
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
69
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
70 *Translated sequences are taken from the best alignment (Best_Hit attribute) within a domain region, however this alignment does not necessarily have to cover the whole region reported as a domain in gff file*
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
71
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
72
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
73 </help>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
74 </tool>
77d9f2ecb28a Uploaded
petr-novak
parents:
diff changeset
75