annotate import2graphlan.xml @ 44:d3e731ed55b1 draft

Uploaded
author george-weingart
date Sat, 06 Sep 2014 13:58:26 -0400
parents c5c1037078e5
children 789d81a1c389
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
1 <tool id="import2graphlan" name="import2graphlan" version="1.0.0">
25
9ecf8701f72f Uploaded
george-weingart
parents: 23
diff changeset
2 <description>Import to Graphlan</description>
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
3 <command interpreter="python">
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
4 export2graphlan.py
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
5 -i $inp_data
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
6 -o $out_data
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
7 -t $output_tree_file
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
8 -a $output_annot_file
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
9
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
10 --annotations $export_annotations
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
11 --external_annotations $export_external_annotations
37
233b2e67d6ea Uploaded
george-weingart
parents: 36
diff changeset
12 --background_levels $background_levels
38
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
13
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
14
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
15 #if $str($gchoice.global_choice) == "a":
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
16
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
17 #if $str($gchoice.background_clades) != " ":
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
18 --background_clades $gchoice.background_clades
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
19 #end if
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
20 #if $str($gchoice.background_colors) != " ":
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
21 --background_colors $gchoice.background_colors
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
22 #end if
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
23
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
24 #if $str($gchoice.export_title) != " ":
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
25 --title $gchoice.export_title
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
26 #end if
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
27
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
28
39
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
29
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
30
38
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
31 --title_font_size $gchoice.title_font_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
32 --def_clade_size $gchoice.def_clade_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
33 --min_clade_size $gchoice.min_clade_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
34 --max_clade_size $gchoice.max_clade_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
35 --def_font_size $gchoice.def_font_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
36 --min_font_size $gchoice.min_font_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
37 --max_font_size $gchoice.max_font_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
38 --annotation_legend_font_size $gchoice.annotation_legend_font_size
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
39 --abundance_threshold $gchoice.abundance_threshold
39
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
40 --least_biomarkers $gchoice.least_biomarkers
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
41
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
42 #if $str($gchoice.discard_otus ) == "1":
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
43 --discard_otus
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
44 #end if
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
45 #end if
38
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
46
c670bf87b733 Uploaded
george-weingart
parents: 37
diff changeset
47
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
48
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
49 --skip_rows 1,2
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
50 </command>
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
51
29
3b2b6c5e38e2 Uploaded
george-weingart
parents: 27
diff changeset
52 <inputs>
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
53 <param format="tabular" name="inp_data" type="data" label="Input used to run Lefse" help="This is the file that was used as input for Lefse"/>
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
54 <param format="lefse_internal_res" name="out_data" type="data" label="Output of Lefse" help="This is the Lefse output file"/>
29
3b2b6c5e38e2 Uploaded
george-weingart
parents: 27
diff changeset
55 <param name="export_annotations" type="text" format="text" label="Annotations" value="2,3"/>
3b2b6c5e38e2 Uploaded
george-weingart
parents: 27
diff changeset
56 <param name="export_external_annotations" type="text" format="text" label="External Annotations" value="4,5,6"/>
37
233b2e67d6ea Uploaded
george-weingart
parents: 36
diff changeset
57 <param name="background_levels" type="text" format="text" label="Background Levels" value="1,2,3"/>
30
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
58
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
59 <conditional name="gchoice">
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
60 <param name="global_choice" type="select" label="Select Global Choices" help="Select choices">
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
61 <option value="d" selected='True'>Default</option>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
62 <option value="a">Advanced</option>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
63 </param>
44
d3e731ed55b1 Uploaded
george-weingart
parents: 43
diff changeset
64 <when value="d">
d3e731ed55b1 Uploaded
george-weingart
parents: 43
diff changeset
65 <param name="background_clades" type="hidden" format="text" label="Background Clades" value="" />
d3e731ed55b1 Uploaded
george-weingart
parents: 43
diff changeset
66 </when>
30
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
67 <when value="a">
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
68 <param name="background_clades" type="text" format="text" label="Background Clades" value=" " />
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
69 <param name="background_colors" type="text" format="text" label="Background Colors" value=" " />
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
70 <param name="export_title" type="text" format="text" label="Title" value=" "/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
71 <param name="title_font_size" type="integer" size="4" value="15" label="Title font size"/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
72 <param name="def_clade_size" type="integer" size="4" value="0" label="Default Clade size"/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
73 <param name="min_clade_size" type="integer" size="4" value="20" label="Minimum Clade size that are Biomarkers"/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
74 <param name="max_clade_size" type="integer" size="4" value="200" label="Maximum Clade size that are Biomarkers"/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
75 <param name="def_font_size" type="integer" size="4" value="10" label="Default font size"/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
76 <param name="min_font_size" type="integer" size="4" value="8" label="Minimum font size "/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
77 <param name="max_font_size" type="integer" size="4" value="12" label="Maximum font size "/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
78 <param name="annotation_legend_font_size" type="integer" size="4" value="10" label="Annotation legend font size "/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
79 <param name="abundance_threshold" type="float" value="20.0" label="Abundance threshold: minimun abundace value for a clade to be annotated"/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
80 <param name="most_abundant" type="integer" size="4" value="0" label=" When only lefse_input is provided, you can specify how many clades to highlight "/>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
81 <param name="least_biomarkers" type="integer" size="4" value="0" label="Minimum number of biomarkers to extract "/>
39
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
82 <param name="discard_otus" type="select" label="If specified the OTU ids will be discarded from the taxonomy" value="0" >
41
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
83 <option value="0">No</option>
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
84 <option value="1">Yes</option>
39
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
85 </param>
30
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
86 </when>
b4fb4d403061 Uploaded
george-weingart
parents: 29
diff changeset
87 </conditional>
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
88 </inputs>
29
3b2b6c5e38e2 Uploaded
george-weingart
parents: 27
diff changeset
89 <outputs>
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
90 <data name="output_annot_file" format="circl" />
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
91 <data name="output_tree_file" format="circl" />
29
3b2b6c5e38e2 Uploaded
george-weingart
parents: 27
diff changeset
92 </outputs>
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
93
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
94 <help>
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
95 Overview
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
96 ========
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
97 **export2graphlan** is an *OPTIONAL* tool that automatically convert **LEfSe**, **MetaPhlAn2**, and **HUMAnN** input and/or output files, to **GraPhlAn**. Input file can be also given in BIOM (both 1 and 2) format.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
98
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
99 The aim of this tool is to support biologists, helping them by provide the tree and the annotation file for GraPhlAn, automatically.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
100
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
101 Input files
39
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
102 ===========
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
103
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
104 As shown in the image below, export2graphlan can work with just one of the following files or with both of them.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
105
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
106 * **Result of MetaPhlAn or HUMAnN analysis**: As depicted in the image below, this file can be the result of a MetaPhlAn analysis or a HUMAnN analysis. Generally, it is a tab separated file that have for each row a taxonomy and an abundance value.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
107
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
108 * **Output of LEfSe**: This file is the result of LEfSe execute on the *Result of MetaPhlAn or HUMAnN analysis* file. This file allow GraPhlAn to highlight for you the found biomarkers.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
109
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
110 Input parameters
41
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
111 ================
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
112
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
113 **--annotations** ANNOTATIONS List which levels should be annotated in the tree. Use a comma separate values form, e.g., -annotation_levels 1,2,3. Default is None
41
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
114
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
115 **--external_annotations** EXTERNAL_ANNOTATIONS
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
116 List which levels should use the external legend for the annotation. Use a comma separate values form,
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
117 e.g., --annotation_levels 1,2,3. Default is None
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
118
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
119 **--background_levels** BACKGROUND_LEVELS
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
120 List which levels should be highlight with a shaded
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
121 background. Use a comma separate values form, e.g.,
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
122 --background_levels 1,2,3
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
123
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
124 **--background_clades** BACKGROUND_CLADES
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
125 Specify the clades that should be highlight with a shaded background. Use a comma separate values form and surround the string with " if it contains spaces.
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
126 Example: --background_clades "Bacteria.Actinobacteria,
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
127 Bacteria.Bacteroidetes.Bacteroidia,
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
128 Bacteria.Firmicutes.Clostridia.Clostridiales"
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
129
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
130 **--background_colors** BACKGROUND_COLORS
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
131 Set the color to use for the shaded background. Colors can be either in RGB or HSV (using a semi-colon to separate values, surrounded with ()) format.
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
132 Use a comma separate values form and surround the string with " if it contains spaces.
44
d3e731ed55b1 Uploaded
george-weingart
parents: 43
diff changeset
133 Example: #29cc36, (150; 100; 100), (280;80; 88)
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
134
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
135 **--title TITLE** If specified set the title of the GraPhlAn plot.
42
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
136 Surround the string with " if it contains spaces, e.g., --title "Title example"
fa2bd894219f Uploaded
george-weingart
parents: 41
diff changeset
137
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
138 **--title_font_size** TITLE_FONT_SIZE
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
139 Set the title font size. Default is 15
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
140
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
141 **--def_clade_size** DEF_CLADE_SIZE
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
142 Set a default size for clades that are not found as biomarkers by LEfSe. Default is 10
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
143
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
144 **--min_clade_size** MIN_CLADE_SIZE
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
145 Set the minimum value of clades that are biomarkers.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
146 Default is 20
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
147
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
148 **--max_clade_size** MAX_CLADE_SIZE
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
149 Set the maximum value of clades that are biomarkers.
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
150 Default is 200
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
151
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
152 **--def_font_size** DEF_FONT_SIZE
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
153 Set a default font size. Default is 10
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
154
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
155 **--min_font_size** MIN_FONT_SIZE
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
156 Set the minimum font size to use. Default is 8
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
157
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
158 **--max_font_size** MAX_FONT_SIZE
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
159 Set the maximum font size. Default is 12
43
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
160
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
161 **--annotation_legend**_font_size ANNOTATION_LEGEND_FONT_SIZE
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
162 Set the font size for the annotation legend. Default is 10
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
163
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
164 **--abundance_threshold** ABUNDANCE_THRESHOLD
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
165 Set the minimun abundace value for a clade to be annotated. Default is 20.0
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
166
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
167 **--most_abundant** MOST_ABUNDANT
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
168 When only lefse_input is provided, you can specify how many clades highlight.
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
169 Since the biomarkers are missing, they will be chosen from the most abundant
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
170
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
171 **--least_biomarkers** LEAST_BIOMARKERS
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
172 When only lefse_input is provided, you can specify the minimum number of biomarkers to extract.
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
173 The taxonomy is parsed, and the level is choosen in order to have at least the specified number of biomarkers
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
174
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
175 **--discard_otus** If specified the OTU ids will be discarded from the taxonmy.
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
176 Default behavior keep OTU ids in taxonomy
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
177
c5c1037078e5 Uploaded
george-weingart
parents: 42
diff changeset
178 **--internal_levels** If specified sum-up from leaf to root the abundances values. Default behavior do not sum-up abundances on the internal nodes
25
9ecf8701f72f Uploaded
george-weingart
parents: 23
diff changeset
179
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
180
41
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
181 Input data matrix parameters
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
182 ============================
39
c4ffb0c51836 Uploaded
george-weingart
parents: 38
diff changeset
183
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
184 --sep SEP
41
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
185
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
186 --out_table OUT_TABLE : This is where to write the processed data matrix to file
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
187
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
188 --fname_row FNAME_ROW : Row number containing the names of the features (default 0, specify -1 if no names are present in the matrix)
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
189
41
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
190 --sname_row SNAME_ROW column number containing the names of the samples (default 0, specify -1 if no names are present in the matrix)
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
191
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
192 --metadata_rows METADATA_ROWS Row numbers to use as metadata[default None, meaning no metadata
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
193
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
194 --skip_rows SKIP_ROWS Row numbers to skip (0-indexed, comma separated) from the input file[default None, meaning no rows skipped
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
195
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
196 --sperc SPERC Percentile of sample value distribution for sample selection
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
197
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
198 --fperc FPERC Percentile of feature value distribution for sample selection
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
199
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
200 --stop STOP Number of top samples to select (ordering based on percentile specified by --sperc)
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
201
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
202 --ftop FTOP Number of top features to select (ordering based on percentile specified by --fperc)
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
203
34a1b347e2e7 Uploaded
george-weingart
parents: 40
diff changeset
204 --def_na DEF_NA Set the default value for missing values [default None which means no replacement]
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
205
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
206 Integration
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
207 ===========
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
208
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
209 A graphical representation of how **export2graphlan** can be integrated in the analysis pipeline:
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
210
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
211 .. image:: https://bitbucket.org/repo/oL6bEG/images/3364692296-graphlan_integration.png
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
212 :height: 672
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
213 :width: 800
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
214
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
215 Want to know more?
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
216 ==================
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
217
27
252c242518f2 Uploaded
george-weingart
parents: 26
diff changeset
218 If you want to know more about **export2graphlan** please have a look at the tutorial `here`_
26
4c76917ae3d7 Uploaded
george-weingart
parents: 25
diff changeset
219
4c76917ae3d7 Uploaded
george-weingart
parents: 25
diff changeset
220
27
252c242518f2 Uploaded
george-weingart
parents: 26
diff changeset
221 .. _here: https://bitbucket.org/nsegata/graphlan/wiki/export2graphlan%20-%20tutorial
23
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
222 </help>
01ba9f83f9a7 Renamed the function to import rather than export
george-weingart
parents:
diff changeset
223 </tool>