annotate mgescan.xml @ 1:b7ea9a0e2714 draft

Uploaded
author hyungrolee
date Sat, 14 Jun 2014 19:06:49 -0400
parents c9fe27da991c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
1 <?xml version="1.0"?>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
2
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
3 <tool name="MGEScan" id="mgescan" version="0.0.1" workflow_compatible="false">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
4 <description>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
5 MGEScan
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
6 </description>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
7 <command interpreter="bash">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
8 mgescan.sh $input '$input.name' 3 $output $program $clade $qvalue_en $qvalue_rt $ltr_gff3 $nonltr_gff3
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
9 <!-- mgescan.sh $input $input.name $hmmver $output $program $clade $qvalue_en $qvalue_rt $ltr_gff3 $nonltr_gff3 -->
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
10 </command>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
11 <inputs>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
12 <param format="txt" name="input" type="data" label="From"/>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
13 <!--param name="hmmver" type="select" label="Hmmsearch version">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
14 <option selected="selected" value="3">3</option>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
15 <option value="2">2</option>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
16 </param-->
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
17 <param name="program" type="select" label="MGEScan">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
18 <option selected="selected" value="B">Both</option>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
19 <option value="L">LTR</option>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
20 <option value="N">nonLTR</option>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
21 </param>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
22 </inputs>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
23 <outputs>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
24 <data format="ltr.out" name="output">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
25 <filter>program != "N"</filter>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
26 </data>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
27 <data format="fasta" name="clade">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
28 <filter>program != "L"</filter>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
29 </data>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
30 <data format="qfile" name="qvalue_en">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
31 <filter>program != "L"</filter>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
32 </data>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
33 <data format="qfile" name="qvalue_rt">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
34 <filter>program != "L"</filter>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
35 </data>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
36 <data format="gff3" name="ltr_gff3">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
37 <filter>program != "N"</filter>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
38 </data>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
39 <data format="gff3" name="nonltr_gff3">
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
40 <filter>program != "L"</filter>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
41 </data>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
42
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
43 </outputs>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
44 <help>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
45 Running the program
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
46 ===================
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
47
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
48 To run MGEScan, select input genome data in From select box, and select program either LTR, nonLTR or both.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
49
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
50 Click 'Execute' button.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
51
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
52 If you like to have more options to run LTR or nonLTR progrma, use separated tools on the left panel.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
53 In LTR > MGEScan-LTR, preprocessing by repeatmasker and setting other variables are available e.g. distance(bp) between LTRs.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
54
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
55 Output
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
56 ============
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
57 A. MGEScan_LTR:
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
58 Upon completion, MGEScan-LTR generates a file "ltr.out". This output file has information
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
59 about clusters and coordinates of LTR retrotransposons identified. Each cluster of LTR
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
60 retrotransposons starts with the head line of "[cluster_number]---------", followed by
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
61 the information of LTR retrotransposons in the cluster. The columns for LTR
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
62 retrotransposons are as follows.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
63
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
64 1. LTR_id: unique id of LTRs identified. It consist of two components, sequence file name and id in the file. For example, chr1_2 is the second LTR retrotransposon in the chr1 file.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
65 2. start position of 5’ LTR.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
66 3. end position of 5’ LTR.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
67 4. start position of 3’ LTR.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
68 5. end position of 3’ LTR.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
69 6. strand: + or -.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
70 7. length of 5’ LTR.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
71 8. length of 3’ LTR.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
72 9. length of the LTR retrotransposon.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
73 10. TSD on the left side of the LTR retotransposons.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
74 11. TSD on the right side of the LTR retrotransposons.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
75 12. di(tri)nucleotide on the left side of 5’LTR
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
76 13. di(tri)nucleotide on the right side of 5’LTR
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
77 14. di(tri)nucleotide on the left side of 3’LTR
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
78 15. di(tri)nucleotide on the right side of 3’LTR
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
79
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
80 B. MGEScan_nonLTR:
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
81 Upon completion, MGEScan-nonLTR generates the directory, "info" in the data directory you
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
82 specified. In this "info" directory, two sub-directories ("full" and "validation") are
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
83 generated.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
84
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
85 - The "full" directory is for storing sequences of elements. Each subdirectory in "full"
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
86 is the name of clade. In each directory of clade, the DNA sequences of nonLTRs identified
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
87 are listed. Each sequence is in fasta format. The header contains the position
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
88 information of TEs identified:
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
89 [genome_file_name]_[start position in the sequence]
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
90
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
91 For example, >chr1_333 means that this element start at 333bp in the "chr1" file.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
92
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
93 - The "validation" directory is for storing Q values. In the files "en" and "rt", the first column corresponds to the element name and the last column Q value.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
94
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
95 License
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
96 ============
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
97 Copyright 2014 Mina Rho, Haixu Tang.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
98 You may redistribute this software under the terms of the GNU General Public License.
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
99
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
100 </help>
c9fe27da991c Uploaded
hyungrolee
parents:
diff changeset
101 </tool>