annotate cluster.tools/gen.survival.curves.xml @ 2:b442996b66ae draft

Uploaded
author peter-waltman
date Wed, 27 Feb 2013 20:17:04 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
1 <tool id="gen_survival_curve" name="Generate Kaplan-Meiers Plot for Cluster Result" force_history_refresh="True">
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
2 <command interpreter="python">gen.survival.curves.py
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
3 -C ${cluster_cls}
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
4 -S ${survial_data}
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
5 -M ${mode}
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
6 -T "${title}"
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
7 -I ${image_format_cond.image_format}
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
8 #if str($image_format_cond.image_format) == 'png':
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
9 -O $report_png
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
10 #end if
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
11 #if str($image_format_cond.image_format) == 'pdf':
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
12 -O $report_pdf
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
13 #end if
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
14 </command>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
15 <inputs>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
16 <param name="cluster_cls" type="data" format="rdata" label="Clustering Classification" help="Specify the clustering classification (must be RData file, see help)"/>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
17 <param name="survial_data" type="data" format="tabular" label="Clinical Data" help="Specify the clinical data to use for the Kaplan-Meiers Plot (see help)"/>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
18 <param name="mode" type="select" display='radio' label="Report Mode" help="Specify the mode to use when performing Log-Rank tests">
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
19 <option value="all" selected='true' >All</option>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
20 <option value="one">One</option>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
21 <option value="both">Both</option>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
22 </param>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
23 <conditional name="image_format_cond">
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
24 <param name="image_format" type="select" display='radio' label="Image format" help="">
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
25 <option value="pdf">PDF</option>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
26 <option value="png" selected='true' >PNG (html wrapper)</option>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
27 </param>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
28 </conditional>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
29
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
30 <param name="title" type="text" label="Title" value="Report" help="Specify title to use in Kaplan-Meiers Plot"/>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
31 </inputs>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
32 <outputs>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
33 <data format="png" name="report_png" label="Kaplan-Meier Survival Plot (PNG)">
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
34 <filter>(image_format_cond['image_format']=="png")</filter>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
35 </data>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
36 <data format="pdf" name="report_pdf" label="Kaplan-Meier Survival Plot (PDF)">
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
37 <filter>(image_format_cond['image_format']=="pdf")</filter>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
38 </data>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
39 </outputs>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
40 <help>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
41 .. class:: infomark
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
42
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
43 **Generate a Kaplan-Meiers Plot for a given cluster result**
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
44
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
45 ----
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
46
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
47 **Parameters**
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
48
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
49 - **Clustering Classification** Specify the clustering classification (RData file format - use the 'Convert tab-delimited Cluster Assignments to RData" tool to convert assignments in tab-delimited format).
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
50
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
51 - **Clinical Data** Clinical data to use for the Kaplan-Meiers Plot (must be formated - See the "Format Raw TCGA sample IDs")
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
52
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
53 - **Report Mode** Mode to use when performing Log-Rank tests **(MUST SPECIFY A PROPERLY FORMATTED CLINICAL DATA FILE)** . Choice of:
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
54
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
55 * All - All clusters versus each other
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
56 * One - One cluster versus a meta-cluster composed of the others. Search performed exhaustively.
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
57 * Both - Perform both all-v-all and and one-v-others test; select the choice of K that gives the best
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
58
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
59 - **Title** - Title to use for Kaplan-Meiers Plot
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
60
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
61 </help>
b442996b66ae Uploaded
peter-waltman
parents:
diff changeset
62 </tool>