annotate queue_genotype_workflow.xml @ 9:0ed7dc418a6d draft

Uploaded
author greg
date Wed, 22 Jan 2020 08:48:41 -0500
parents aa6274d3b20e
children 560dcf3f9f3d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
1 <tool id="queue_genotype_workflow" name="Queue genotype workflow" version="1.0.0">
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
2 <description></description>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
3 <command detect_errors="exit_code"><![CDATA[
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
4 #set history_id = $__app__.security.encode_id($affy_metadata.history.id)
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
5 python $__tool_directory__/queue_genotype_workflow.py
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
6 --affy_metadata '$affy_metadata'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
7 --annot '$annot'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
8 --api_key $get_user_api_key
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
9 --calls '$calls'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
10 --confidences '$confidences'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
11 --config_file $__tool_directory__/qgw_config.ini
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
12 --history_id $history_id
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
13 --reference_genome '$locally_cached_item.fields.path'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
14 --dbkey '$locally_cached_item.fields.value'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
15 --report '$report'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
16 --sample_attributes '$sample_attributes'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
17 --snp-posteriors '$snp_posteriors'
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
18 --summary '$summary'
6
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
19 #if str($output_nj_phylogeny_tree) == "yes":
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
20 --output_nj_phylogeny_tree '$output_nj_phylogeny_tree'
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
21 #end if
0
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
22 --output '$output']]></command>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
23 <configfiles>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
24 <configfile name="get_user_api_key"><![CDATA[#from galaxy.managers import api_keys#${api_keys.ApiKeyManager( $__app__ ).get_or_create_api_key($__user__)} ]]></configfile>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
25 </configfiles>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
26 <inputs>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
27 <param name="affy_metadata" type="data" format="tabular" label="Affymetrix 96 well plate metadata file" help="The word 'metadata' must be in the file name.">
2
fa50d7c895c2 Uploaded
greg
parents: 0
diff changeset
28 <validator type="expression" message="96 well plate data must have 32 columns"><![CDATA[value is not None and value.metadata.columns==32]]></validator>
0
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
29 </param>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
30 <param name="sample_attributes" type="data" format="tabular" label="Sample attributes file" help="The word 'attributes' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
31 <param name="annot" type="data" format="csv" label="Probeset annotation file" help="The word 'annotation' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
32 <param name="summary" type="data" format="txt" label="Apt-probeset genotype summary file" help="The word 'summary' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
33 <param name="snp_posteriors" type="data" format="txt" label="Apt-probeset genotype snp-posteriors file" help="The word 'snp-posteriors' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
34 <param name="report" type="data" format="txt" label="Apt-probeset genotype report file" help="The word 'report' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
35 <param name="confidences" type="data" format="txt" label="Apt-probeset genotype confidences file" help="The word 'confidences' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
36 <param name="calls" type="data" format="txt" label="Apt-probeset genotype calls file" help="The word 'calls' must be in the file name."/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
37 <param name="locally_cached_item" type="select" format="fasta" label="Fasta reference sequence">
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
38 <options from_data_table="all_fasta">
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
39 <column name="name" index="2"/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
40 <column name="value" index="0"/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
41 <column name="path" index="3"/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
42 <filter type="sort_by" column="1"/>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
43 <validator type="no_options" message="No cached Fasta genome references are available for the build associated with the selected probeset annotation file." />
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
44 </options>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
45 </param>
6
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
46 <param name="output_nj_phylogeny_tree" type="select" display="radio" label="Plot neighbor-joining phylogeny tree in Corals Multilocus Genotype outputs?" help="This may significantly extend the tool execution time">
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
47 <option value="yes">Yes</option>
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
48 <option value="no" selected="true">No</option>
b7212fe2d597 Uploaded
greg
parents: 5
diff changeset
49 </param>
0
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
50 </inputs>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
51 <outputs>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
52 <data name="output" label="${tool.name} execution log" format="txt" />
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
53 </outputs>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
54 <tests>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
55 <test>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
56 <!--Testing this tool is a bit difficult at the current time.-->
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
57 </test>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
58 </tests>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
59 <help>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
60 **What it does**
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
61
5
934acc64b30c Uploaded
greg
parents: 3
diff changeset
62 Uses the Galaxy/Bioblend API to execute the complete multilocus genotype analysis pipeline for corals or symbionts.
9
0ed7dc418a6d Uploaded
greg
parents: 8
diff changeset
63 Read this tutorial_ if you are not familiar with this tool. This tool must be able to access the corals (stag) database.
0ed7dc418a6d Uploaded
greg
parents: 8
diff changeset
64
0ed7dc418a6d Uploaded
greg
parents: 8
diff changeset
65 .. _tutorial: https://github.com/gregvonkuster/galaxy_tools/blob/master/docs/corals/coralsnp_tutorial.md
0
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
66
3
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
67 **Required options**
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
68
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
69 * **Affymetrix 96 well plate metadata file** - a tabular file created by the user to describe their samples - it can be exported from Excel using this example as a template: http://baumslab.org/documents/SNPChip/STAG_Metadata_Template_v3.xlsm
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
70 * **Sample attributes file** - the Sample Attributes tabular file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
71 * **Probeset annotation file** - the annotation CSV file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
72 * **Apt-probeset genotype summary file** - the summary CSV file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
73 * **Apt-probeset genotype snp-posteriors file** - the snp-posteriors CSV file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
74 * **Apt-probeset genotype report file** - the report CSV file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
75 * **Apt-probeset genotype confidences file** - the confidences CSV file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
76 * **Apt-probeset genotype calls file** - the calls CSV file created by the Affymetrix sequencer for the plate
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
77 * **Fasta reference sequence** - selected fasta reference dataset for the samples
36f8098ff528 Uploaded
greg
parents: 2
diff changeset
78
0
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
79 </help>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
80 <citations>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
81 <citation type="bibtex">
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
82 @misc{None,
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
83 journal = {None},
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
84 author = {Baums I},
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
85 title = {Manuscript in preparation},
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
86 year = {None},
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
87 url = {http://baumslab.org}
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
88 </citation>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
89 </citations>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
90 </tool>
c80fae8c94c1 Uploaded
greg
parents:
diff changeset
91