annotate data_manager/add_ctat_centrifuge_index.xml @ 15:367b0d693b0c draft default tip

Uploaded
author trinity_ctat
date Mon, 30 Apr 2018 16:17:37 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
1 <tool id="ctat_centrifuge_indexes_data_manager"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
2 name="CTAT Centrifuge Indexes Data Manager"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
3 version="1.0.0" tool_type="manage_data">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
4 <description>Retrieve, and/or specify the location of, a CTAT Centrifuge Index.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
5 </description>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
6 <requirements>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
7 <requirement type="package" version="2.7">python</requirement>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
8 </requirements>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
9 <command detect_errors="default">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
10 <![CDATA[
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
11 python $__tool_directory__/add_ctat_centrifuge_index.py
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
12 --display_name "${display_name}"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
13 --destination_path "${destination}"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
14 --output_filename "${out_file}"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
15 #if str( $download_question.download ) == "true":
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
16 --download_location "\"${download_question.filename}\""
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
17 #if str( $download_question.force_download ) == "true":
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
18 --force_download
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
19 #end if
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
20 #end if
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
21 ]]>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
22 </command>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
23 <inputs>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
24 <!-- The following are left in here, just as examples of various ways of doing options.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
25 <param name="force_download" type="boolean" checked="false"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
26 truevalue="- -force_download" falsevalue="" label="Force New Download? (yes/no)" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
27 <param name="download" type="select" label="Need to Download?">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
28 <option value="single" selected="true">Single Dataset</option>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
29 <option value="paired_collection">Paired Collection</option>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
30 <when value="paired_collection">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
31 <param name="fastq_input" format="fastqsanger" type="data_collection" collection_type="paired" label="Select dataset pair" help="Specify paired dataset collection containing paired reads"/>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
32 </when>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
33 -->
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
34 <conditional name="download_question">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
35 <param name="download" type="boolean" checked="false" label="Need to Download?" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
36 <when value="true">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
37 <!-- The use of a code block to get dynamic options is now deprecated and discouraged.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
38 I am still using it here. The only other way I can think of to do this is to
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
39 create another data_manager that gets the list of files and puts them into a
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
40 data_table, that is then used to get the filenames. That would require the admin
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
41 to first run the data_manager that builds the filename data_table before running
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
42 this data_manager.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
43 However, I have not been able to figure out how to send information back correctly
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
44 from the function and there is no documentation that I have found showing how to do it.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
45 <param name="filename" type="select" label="Select File" display="radio"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
46 dynamic_options="get_ctat_centrifuge_index_locations()"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
47 help="Select a Centrifuge Index to Download." />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
48 Hard coded version.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
49 <param name="filename" type="text" value="ftp://ftp.ccb.jhu.edu/pub/infphilo/centrifuge/data/p_compressed+h+v.tar.gz">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
50 <option value="ftp://ftp.ccb.jhu.edu/pub/infphilo/centrifuge/data/p_compressed+h+v.tar.gz">
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
51 p_compressed+h+v
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
52 </option>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
53 </param>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
54 -->
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
55 <param name="filename" type="select" label="Select File"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
56 dynamic_options="get_ctat_centrifuge_index_locations()"
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
57 help="Select a Centrifuge Index to Download." />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
58 <param name="force_download" type="boolean" checked="false" label="Force New Download?" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
59 </when>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
60 </conditional>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
61
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
62 <param name="display_name" type="text" label="Centrifuge Index Display Name" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
63 <param name="destination" type="text" label="Local Destination (full path)" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
64 </inputs>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
65 <outputs>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
66 <data name="out_file" format="data_manager_json" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
67 </outputs>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
68 <help>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
69 Retrieve, and/or specify the location of, a CTAT Centrifuge Index.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
70 When download is true, the file at ftp://ftp.ccb.jhu.edu/pub/infphilo/centrifuge/data/p_compressed+h+v.tar.gz
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
71 will be the URL from which the index is downloaded. Currently that is the only supported index.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
72 Specify the Full Path of the destination where the CTAT Reference Library should be placed.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
73 If you already have the index, specify the full path of the location where it exists and leave the download box unchecked.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
74 The display_name may be left empty if downloading.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
75 The display_name will be used as the selector text of the entry in the data table.
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
76 </help>
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
77 <code file="add_ctat_centrifuge_index.py" />
367b0d693b0c Uploaded
trinity_ctat
parents:
diff changeset
78 </tool>