Mercurial > repos > galaxyp > metaquantome

annotate metaquantome_expand.xml @ 8:a1df90e6e7d4 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload
author galaxyp
date Fri, 08 Feb 2019 10:36:53 -0500
parents 80ce9ca55697
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
1 <tool id="metaquantome_expand" name="metaQuantome: expand" version="@VERSION@.0">
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
2 <description>annotated functional or taxonomy terms to include all terms</description>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
3 <macros>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
4 <import>macros.xml</import>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
5 </macros>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
6 <expand macro="requirements" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
8 mkdir -p data && #slurp
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
9 @MAKE_SAMPS_TSV@
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
10 metaquantome expand
1
47bfbd6597d0 planemo upload commit 636fd1c7e60779d1123056a2985d54881013d4cb
galaxyp
parents: 0
diff changeset
11 @EXPAND_PARAMS@
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
12 @DB_DIR@
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
13 #if $input.input_type == 'nopep':
4
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
14 --nopep --nopep_file='$input.nopep_file'
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
15 #else:
4
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
16 --int_file='$input.int_file'
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
17 --pep_colname_int='$input.pep_colname_int'
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
18 #end if
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
19 --outfile='$outfile'
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
20 ]]></command>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
21 <inputs>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
22 <expand macro="data_dir"/>
1
47bfbd6597d0 planemo upload commit 636fd1c7e60779d1123056a2985d54881013d4cb
galaxyp
parents: 0
diff changeset
23 <expand macro="expand_params"/>
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
24 <conditional name="input">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
25 <param name="input_type" type="select" label="Select input data">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
26 <option value="int">tabular intensity file with peptide column</option>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
27 <option value="nopep">file without a peptide column</option>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
28 </param>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
29 <when value="int">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
30 <param argument="--int_file" type="data" format="tabular" label="intensity data"
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
31 help=""/>
4
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
32 <param argument="--pep_colname_int" type="text" value="" label="Peptide column name"
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
33 help="The column name within the intensity file that corresponds to the peptide sequences">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
34 <validator type="empty_field"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
35 </param>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
36 </when>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
37 <when value="nopep">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
38 <param argument="--nopep_file" type="data" format="tabular" label="intensity data"
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
39 help=""/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
40 </when>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
41 </conditional>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
42 <expand macro="output_samples_choice"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
43 </inputs>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
44 <outputs>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
45 <data format="tabular" name="outfile" label="${tool.name} on ${on_string} expanded"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
46 <expand macro="output_samples"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
47 </outputs>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
48 <tests>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
49 <test>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
50 <param name="int_file" value="int_ttest.tab" ftype="tabular"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
51 <param name="pep_colname_int" value="peptide" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
52 <param name="func_file" value="multiple_func.tab" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
53 <param name="pep_colname_func" value="peptide" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
54 <param name="func_colname" value="go"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
55 <param name="mode" value="f" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
56 <param name="ontology" value="go" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
57 <param name="samps_src" value="build" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
58 <repeat name="samps">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
59 <param name="group_name" value="s1"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
60 <param name="col_names" value="int1,int2,int3"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
61 </repeat>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
62 <repeat name="samps">
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
63 <param name="group_name" value="s2"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
64 <param name="col_names" value="int4,int5,int6"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
65 </repeat>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
66 <output name="outfile" file="go_expanded.tab" ftype="tabular"/>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
67 </test>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
68 </tests>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
69 <help><![CDATA[
4
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
70 metaQuantome expand
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
71 ===================
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
72
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
73 The *expand* module is the first step in the metaQuantome analysis workflow,
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
74 and can be run to analyze function, taxonomy, or function and taxonomy together.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
75
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
76 See the figure below for an overview of the metaQuantome workflow:
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
77
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
78 .. image:: metaquantome_program_structure.png
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
79 :width: 100 %
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
80
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
81 **metaQuantome workflow**: (A) Outline of metaQuantome program structure, (B) expanding the hierarchy, (C) and the definition of the total term abundance.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
82
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
83
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
84 The following information is required for all 4 analysis modes:
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
85
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
86 - experimental design information
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
87 - a tab-separated peptide intensity file
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
88 - the name of the peptide column in the intensity file
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
89
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
90 Function mode
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
91 -------------
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
92
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
93 In function mode, the following information is required:
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
94
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
95 - the ontology being used: Gene Ontology (go), Clusters of Orthologous Groups (COG), or Enzyme Commission (EC) numbers.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
96 - a tab-separated functional annotation file, with a peptide column and a functional annotation column. An entry in the functional annotation column may contain multiple functional annotations separated by a comma.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
97 - the name of the peptide column in the functional annotation file
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
98 - the name of the functional annotation column in the functional annotation file
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
99
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
100 Taxonomy mode
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
101 -------------
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
102
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
103 In taxonomy mode, the following information is required:
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
104
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
105 - a tab-separated taxonomy annotation file, with a peptide column and a taxonomy annotation column. The taxonomic annotations should be the lowest common ancestor (LCA) for each peptide, preferably given as NCBI taxonomy IDs.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
106 - the name of the peptide column in the taxonomic annotation file
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
107 - the name of the taxonomy annotation column in the taxonomy annotation file
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
108
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
109 Function-Taxonomy mode
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
110 ----------------------
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
111
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
112 In the combined mode, all of the above must be provided. In addition, the "target rank" must be provided, which is the desired taxonomic rank at which to summarize the function/taxonomy results.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
113
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
114 Databases
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
115 ---------
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
116
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
117 Currently, metaQuantome on Galaxy is only set up to use automatically downloaded databases, so your results may change slightly from run to run. In the future, we plan to enable cached databases in Galaxy.
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
118
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
119 Questions, Comments, Problems, Kudos
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
120 ------------------------------------
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
121
80ce9ca55697 planemo upload commit d27827cf38d30b9c98923f73bc9cae4ffe41361b
galaxyp
parents: 1
diff changeset
122 Please file any issues at https://github.com/galaxyproteomics/tools-galaxyp/issues.
0
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
123 ]]></help>
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
124 <expand macro="citations" />
b17b03126d40 planemo upload commit c64c8aadb942f00c459963110d51558fad83d920-dirty
galaxyp
parents:
diff changeset
125 </tool>