annotate genomeRetrival.xml @ 1:34b51ff7d639 draft default tip

Uploaded
author 19zhang
date Tue, 13 Oct 2020 07:08:31 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
1 <tool id="genomeindex" name="genomePrepare" workflow_compatible="false" version="20.05">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
2 <!-- <description>get genome sequences, annotation and file path (built-in or uploaded)</description> -->
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
3
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
4 <command><![CDATA[
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
5 bash ${__tool_directory__}/scripts/obtainSpecies.sh
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
6 --curpath ${__tool_directory__}
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
7 #if $genometype.datainput == "UploadData":
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
8 --name "$genometype.speciename"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
9 --genome $genometype.genomeData
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
10 --gff $genometype.annotationData
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
11 --otherrna $genometype.otherrna
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
12 --transcript $genometype.transcriptsData
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
13 --protein $genometype.proteinsData
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
14 --speciesout $filePath
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
15 --infout $infout1
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
16 #else
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
17 --ensembl "$genometype.buildplant"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
18 --verorder "$genometype.version"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
19
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
20 --outgenome $outgenome
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
21 --outgff3 $outgff3
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
22 --outtranscript $outtranscript
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
23 --outtrsnsnoRNA $outtrsnsnoRNA
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
24 --outprotein $outprotein
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
25
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
26 --speciesout $builtinPath
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
27 --infout $infout2
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
28 #end if
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
29
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
30 ]]></command>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
31
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
32 <inputs>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
33 <conditional name="genometype">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
34 <!-- <param name="datainput" type="boolean" truevalue="yes" falsevalue="no" checked="true"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
35 label="Upload your own genome data?" help ="User can also select built-in species by clicking the button-No " /> -->
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
36 <param type="select" name="datainput" display="radio" multiple="false" help="Note: for 'upload from local disk', please upload files by uploadFile function first."
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
37 label="Two ways for preparing genome data:" >
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
38 <option value="BuiltinSpecies" selected="true" > Download from EnsemblPlants database</option>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
39 <option value="UploadData"> Upload from local disk</option>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
40 </param>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
41
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
42 <when value="BuiltinSpecies">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
43 <param name="buildplant" type="select"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
44 label="Species (support for 61 species)"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
45 help="">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
46 <options from_data_table="ensembl_plant" >
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
47 <!-- <filter type="sort_by" column="1"/>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
48 <validator type="no_options" message="No indexes are available for the selected input dataset"/> -->
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
49 </options>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
50 </param>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
51
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
52 <param name="version" type="select"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
53 label="Database version"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
54 help="">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
55 <options from_data_table="ensembl_plant_version">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
56 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
57 </options>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
58 </param>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
59
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
60 </when>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
61
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
62 <when value="UploadData">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
63 <param type="text" name="speciename" value=""
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
64 label="Species"
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
65 help="e.g. Arabidopsis thaliana" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
66
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
67 <param name="genomeData" type="data" format="fasta" optional="true" label="Genome sequences (.fasta)" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
68 <param name="annotationData" type="data" format="gff3" optional="true" label="Annotation file (.gff3)" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
69 <param name="otherrna" type="data" format="fasta" optional="true" label="t/r/sn/snoRNA sequences (.fasta)" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
70 <param name="transcriptsData" type="data" format="fasta" optional="true" label="cDNA sequences (.fasta)" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
71 <param name="proteinsData" type="data" format="fasta" optional="true" label="Optional: Protein sequences (.fasta)" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
72 </when>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
73 </conditional>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
74 </inputs>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
75
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
76 <stdio><exit_code range="1:" level="fatal" description="Error when running ${tool.name}"/></stdio>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
77
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
78 <outputs>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
79 <data format="simple" name="filePath" label="${genometype.speciename.value}">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
80 <filter> genometype['datainput'] == "UploadData" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
81 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
82 <data format="pdf" name="infout1" label="${genometype.speciename.value} | ${tool.name} | Summary of genomic features">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
83 <filter> genometype['datainput'] == "UploadData" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
84 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
85 <data format="simple" name="builtinPath" label="${genometype.buildplant.value}_${genometype.version.value}">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
86 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
87 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
88 <data format="pdf" name="infout2" label="${genometype.buildplant.value}_${genometype.version.value} | ${tool.name} | Summary of genomic features">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
89 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
90 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
91 <data format="gz" name="outgenome" label="${genometype.buildplant.value}_${genometype.version.value} | ${tool.name} | Genome sequences ">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
92 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
93 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
94 <data format="fasta" name="outtrsnsnoRNA" label="${genometype.buildplant.value}_${genometype.version.value} | ${tool.name} | t/r/sn/snoRNA sequences">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
95 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
96 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
97 <data format="gff3" name="outgff3" label="${genometype.buildplant.value}_${genometype.version.value} | ${tool.name} | GFF3 annotations">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
98 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
99 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
100 <data format="fasta" name="outtranscript" label="${genometype.buildplant.value}_${genometype.version.value} | ${tool.name} | cDNA sequences">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
101 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
102 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
103 <data format="fasta" name="outprotein" label="${genometype.buildplant.value}_${genometype.version.value} | ${tool.name} | Protein sequences">
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
104 <filter> genometype['datainput'] == "BuiltinSpecies" </filter>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
105 </data>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
106
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
107 </outputs>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
108
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
109 <tests>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
110 <test>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
111 <param name="genomeData" value="Arabidopsis_genome.fa" ftype="fasta" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
112 <param name="annotationData" value="Arabidopsis_annotation.gff3" ftype="fasta" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
113 <output name="filePath" file="genomePrepare: References_of_Arabidopsis_thaliana.simple" ftype="simple" />
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
114 </test>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
115
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
116 </tests>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
117
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
118
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
119 <help><![CDATA[
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
120
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
121 .. class:: donemark
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
122
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
123 **What it does**
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
124
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
125 This tool provides two ways for preparing genome data:
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
126
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
127 1. Automatically download genomes, annotations, t/r/sn/snoRNAs (i.e. tRNAs, rRNAs, snRNAs, and snoRNAs), cDNAs, and proteins from `EnsemblPlants database`_.
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
128 2. Upload genomic data for species not included in EnsemblPlants.
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
129
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
130 .. class:: infomark
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
131
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
132 **Outputs**
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
133
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
134 - A file containing the path of formatted genome sequences and annotations. Index files of the reference genome and t/r/sn/snoRNA sequences in this path are used for 'miRNAPredict' analysis.
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
135 - Summary of the number and length of genomic features.
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
136 - Genome sequences, annotation file in GFF3 format, t/r/sn/snoRNA sequences, cDNAs, and protein sequences.
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
137
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
138 .. _`EnsemblPlants database`: ftp://ftp.ensemblgenomes.org/pub/plants
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
139
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
140 |
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
141
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
142 ]]></help>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
143
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
144 <citations>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
145 <citation type="doi">10.1007/978-1-4939-6658-5_1</citation>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
146 </citations>
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
147
34b51ff7d639 Uploaded
19zhang
parents:
diff changeset
148 </tool>