annotate mgescan.xml @ 3:1b1cc6a28663 draft

Uploaded
author hyungrolee
date Mon, 15 Feb 2016 01:42:48 -0500
parents 2672622e9ca9
children 33dfa472f8ef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
1 <?xml version="1.0"?>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
2
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
3 <tool name="MGEScan" id="mgescan" version="0.0.2">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
4 <description>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
5 MGEScan
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
6 </description>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
7 <command interpreter="bash">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
8 mgescan.sh $input '$input.name' 3 $output $program $clade $qvalue_en $qvalue_rt $ltr_gff3 $nonltr_gff3 $both_gff3 $mpi_yn.nmpi
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
9 <!-- mgescan.sh $input $input.name $hmmver $output $program $clade $qvalue_en $qvalue_rt $ltr_gff3 $nonltr_gff3 -->
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
10 </command>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
11 <inputs>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
12 <param format="fasta,tabular,data" name="input" type="data" label="Input FASTA file(s)"/>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
13 <!--param name="hmmver" type="select" label="Hmmsearch version">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
14 <option selected="selected" value="3">3</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
15 <option value="2">2</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
16 </param-->
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
17 <param name="program" type="select" label="MGEScan">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
18 <option selected="selected" value="B">Both</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
19 <option value="L">LTR</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
20 <option value="N">nonLTR</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
21 </param>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
22 <conditional name="mpi_yn">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
23 <param name="mpi_select" type="select" label="Enable MPI">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
24 <option value="no_mpi">No</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
25 <option value="yes_mpi">Yes</option>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
26 </param>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
27 <when value="yes_mpi">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
28 <param name="nmpi" format="txt" type="text" value="1" label="Number of MPI Processes"/>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
29 </when>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
30 <when value="no_mpi">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
31 <param name="nmpi" type="hidden" value="0"/>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
32 </when>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
33 </conditional>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
34 </inputs>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
35 <outputs>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
36 <data format="ltr.out" name="output" label="LTR Results (ltr.out)">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
37 <filter>program != "N"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
38 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
39 <data format="fasta" name="clade" label="clade file (FASTA)">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
40 <filter>program != "L"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
41 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
42 <data format="qfile" name="qvalue_en" label="qvalue_en">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
43 <filter>program != "L"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
44 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
45 <data format="qfile" name="qvalue_rt" label="qvalue_rt">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
46 <filter>program != "L"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
47 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
48 <data format="gff3" name="ltr_gff3" label="GFF3 for LTR">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
49 <filter>program != "N"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
50 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
51 <data format="gff3" name="nonltr_gff3" label="GFF3 for nonLTR">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
52 <filter>program != "L"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
53 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
54 <data format="gff3" name="both_gff3" label="GFF3 for LTR and nonLTR">
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
55 <filter>program == "B"</filter>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
56 </data>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
57
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
58 </outputs>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
59 <help>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
60 How to Run MGEScan
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
61 ===================
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
62
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
63 * Select an input genome data from the select box, and choose a program. Both LTR and nonLTR of MGEScan is default.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
64 * Click 'Execute' button.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
65 * MPI will be enabled depending on your system support.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
66
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
67 If you like to have more options to run LTR or nonLTR program, use separated tools on the left panel.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
68
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
69 For example, in LTR > MGEScan-LTR, preprocessing by repeatmasker and setting other variables are available e.g. distance(bp) between LTRs.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
70
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
71 Output
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
72 ============
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
73
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
74 A. MGEScan_LTR:
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
75
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
76 Upon completion, MGEScan-LTR generates a file "ltr.out". This output file has information
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
77 about clusters and coordinates of LTR retrotransposons identified. Each cluster of LTR
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
78 retrotransposons starts with the head line of "[cluster_number]---------", followed by
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
79 the information of LTR retrotransposons in the cluster. The columns for LTR
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
80 retrotransposons are as follows.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
81
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
82 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.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
83 2. start position of 5’ LTR.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
84 3. end position of 5’ LTR.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
85 4. start position of 3’ LTR.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
86 5. end position of 3’ LTR.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
87 6. strand: + or -.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
88 7. length of 5’ LTR.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
89 8. length of 3’ LTR.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
90 9. length of the LTR retrotransposon.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
91 10. TSD on the left side of the LTR retotransposons.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
92 11. TSD on the right side of the LTR retrotransposons.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
93 12. di(tri)nucleotide on the left side of 5’LTR
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
94 13. di(tri)nucleotide on the right side of 5’LTR
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
95 14. di(tri)nucleotide on the left side of 3’LTR
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
96 15. di(tri)nucleotide on the right side of 3’LTR
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
97
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
98 B. MGEScan_nonLTR:
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
99 Upon completion, MGEScan-nonLTR generates the directory, "info" in the data directory you
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
100 specified. In this "info" directory, two sub-directories ("full" and "validation") are
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
101 generated.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
102
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
103 * The "full" directory is for storing sequences of elements. Each subdirectory in "full"
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
104 is the name of clade. In each directory of clade, the DNA sequences of nonLTRs identified
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
105 are listed. Each sequence is in fasta format. The header contains the position
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
106 information of TEs identified: [genome_file_name]_[start position in the sequence]
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
107
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
108 For example, >chr1_333 means that this element start at 333bp in the "chr1" file.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
109
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
110 * The "validation" directory is for storing Q values.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
111 In the files "en" and "rt", the first column corresponds to the element name and the last column Q value.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
112
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
113 License
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
114 ============
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
115 Copyright 2015.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
116 You may redistribute this software under the terms of the GNU General Public License.
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
117
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
118 </help>
2672622e9ca9 Uploaded
hyungrolee
parents:
diff changeset
119 </tool>