annotate cytoexport.xml @ 7:8bf5e4be0c37 default tip

new .jar; new layout options
author pieter.lukasse@wur.nl
date Wed, 08 Jan 2014 14:30:52 +0100
parents 300fb286515b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool name="CytoExport" id="cytoexport1" version="1.0.2">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description>Exports CSV files to visually rich Cytoscape networks</description>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
3 <!--
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
4 For remote debugging start you listener on port 8000 and use the following as command interpreter:
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
5 java -jar -Xdebug -Xrunjdwp:transport=dt_socket,address=D0100564.wurnet.nl:8000
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
6 //////////////////////////
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
7 This part is a WORKAROUND for the Cytoscape X11 dependency problem, even when running 'headless' (assuming Xfvb is installed/enabled):
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
8 export DISPLAY=:995;
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
9 ...TODO -> this is linux specific...follow issue fix on Cytoscape...perhaps we can add try/catch in python here (see http://www.unix.com/shell-programming-scripting/107334-how-use-catch-try-final-bash-script.html)
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
10 ...check how other tools do this
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
11 -->
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
12 <command interpreter="export DISPLAY=:995; java -jar ">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
13 CytoExport.jar
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
14 -networkName "$csvDataFile.metadata.base_name"
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
15 -csvDataFile $csvDataFile
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
16 -configInputMode $configInputMode.type
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
17 -vizMapPropsFile $configInputMode.vizMapPropsFile
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
18 -vizStyleName $vizStyleName
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
19 -alternativeTableImportJsonFile $configInputMode.alternativeTableImportJsonFile
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
20 -cysOutFile $cysOutFile
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
21 -htmlReportFile $htmlReportFile
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
22 -picturesPath $htmlReportFile.files_path
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
23 -logFile $logFile
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
24 </command>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
25
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
26 <inputs>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
27 <!-- TODO make possible to have multiple networks in same .cys
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
28 <param name="networkName" type="text" size="30" value="" label="Network name" />-->
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
29 <param name="csvDataFile" type="data" format="csv,tabular" label="Network data file" />
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
30
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
31
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
32 <conditional name="configInputMode">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
33 <param name="type" type="select" label="Configuration input">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
34 <option value="customConfig" selected="true">Use custom configuration files</option>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
35 <option value="existingTemplate">Use one of the existing templates</option>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
36 </param>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
37 <when value="existingTemplate">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
38 <param name="alternativeTableImportJsonFile" type="select" label="Select import template">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
39 <option value="/com/pri/cytoexport/resources/simple_xtandem_out.json" >Config for X!Tandem .csv</option>
7
8bf5e4be0c37 new .jar; new layout options
pieter.lukasse@wur.nl
parents: 5
diff changeset
40 <option value="/com/pri/cytoexport/resources/quantifere_network_config.json" >Config for Quantifere .csv (force-directed layout)</option>
8bf5e4be0c37 new .jar; new layout options
pieter.lukasse@wur.nl
parents: 5
diff changeset
41 <option value="/com/pri/cytoexport/resources/quantifere_network_config_no_layout.json" >Config for Quantifere .csv (no layout)</option>
0
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
42 </param>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
43 <param name="vizMapPropsFile" type="select" label="Select vizualization template">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
44 <option value="/com/pri/cytoexport/resources/simple_xtandem_viz.props" >Plain1 for X!Tandem .csv</option>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
45 <option value="/com/pri/cytoexport/resources/quantifere_network_layout.props" >Plain1 for Quantifere .csv</option>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
46 </param>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
47 </when>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
48 <when value="customConfig">
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
49 <param name="alternativeTableImportJsonFile" type="data" format="json" label="Alternative TableImport configuration file" help="The configuration file generated by the 'AlternativeTableImport' plugin"/>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
50 <param name="vizMapPropsFile" type="data" format="any" label="VizMap file" />
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
51 </when>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
52 </conditional>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
53
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
54 <param name="vizStyleName" type="text" size="30" value="default" label="VizMap style to apply"
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
55 help="In which file to display the network"/>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
56
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
57 </inputs>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
58 <outputs>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
59 <data name="htmlReportFile" format="html" label="${csvDataFile.metadata.base_name} - ${tool.name} on ${on_string}: preview" metadata_source="csvDataFile"/>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
60 <data name="cysOutFile" format="cys" label="${csvDataFile.metadata.base_name} - ${tool.name} on ${on_string}: Cytoscape .CYS" metadata_source="csvDataFile"/>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
61 <data name="logFile" format="txt" label="${csvDataFile.metadata.base_name} - ${tool.name} on ${on_string}: logfile" metadata_source="csvDataFile"/>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
62 </outputs>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
63 <tests>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
64 </tests>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
65 <help>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
66
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
67 .. class:: infomark
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
68
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
69 This tool takes in the CSV file and transforms it into a Cytoscape network according to the
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
70 configurations found in the 'Alternative TableImport configuration file'.
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
71
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
72 It provides pipeline automation for generating a visually rich Cytoscape network, which can
5
300fb286515b fixed link
pieter.lukasse@wur.nl
parents: 4
diff changeset
73 also be achieved manually by using the `AlternativeTableImport plugin`_ for Cytoscape.
0
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
74
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
75
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
76 -----
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
77
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
78 **Output details**
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
79
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
80 `See AlternativeTableImport for more details...`__
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
81
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
82
7
8bf5e4be0c37 new .jar; new layout options
pieter.lukasse@wur.nl
parents: 5
diff changeset
83 .. __: javascript:window.open('http://apps.cytoscape.org/apps/alternativetableimport','popUpWindow','height=800,width=1000,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes')
8bf5e4be0c37 new .jar; new layout options
pieter.lukasse@wur.nl
parents: 5
diff changeset
84 .. _AlternativeTableImport plugin: javascript:window.open('http://apps.cytoscape.org/apps/alternativetableimport','popUpWindow','height=800,width=1000,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes')
0
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
85
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
86
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
87
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
88
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
89 </help>
cb11ee34d92f Initial Toolshed commit
pieter.lukasse@wur.nl
parents:
diff changeset
90 </tool>