Mercurial > repos > bgruening > netboxr

comparison netboxr_xml.xml @ 0:785ed8621503 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 13e28726551f8751007f28a3c6cd5d00ba278056
author bgruening
date Wed, 24 Aug 2022 08:27:40 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:785ed8621503
1 <tool id="netboxr" name="netboxr" version="1.6.0">
2 <description>enables automated discovery of biological process modules by network analysis.</description>
3 <requirements>
4 <requirement type="package" version="1.6.0">bioconductor-netboxr</requirement>
5 </requirements>
6 <command detect_errors="exit_code"><![CDATA[
7 Rscript '$__tool_directory__/netboxr_r.R'
8 --geneList '$geneList'
9 --cutoff '$cutoff'
10 --community $community
11 --globalModel $globalModel
12 --globalIterations '$globalIterations'
13 --globalNumber '$globalNumber'
14 --localModel $localModel
15 --localIterations '$localIterations'
16 --networkPlot $networkPlot
17 --plotWidth '$plotWidth'
18 --outputSIF $outputSIF
19 --neighborList $neighborList
20 --modmem $modmem
21 --nt $nt
22 ]]></command>
23 <inputs>
24 <param argument="--geneList" type="data" format="txt" label="Gene list" help="A newline-delimited text file that contains a list of genes of interest" />
25 <param argument="--cutoff" type="float" value="0.05" label="P-Value Cut-Off" help="The corrected p-value (or q-value) cut-off to apply for the graph output. Default: 0.05" />
26 <param argument="--community" type="select" label="Community detection method" help="Community detection methods include edge betweenness score (EBC), leading eigenvector method (LEC), Louvain method (LOUV), or Leiden method (LEID). Default: EBC">
27 <option value="ebc">EBC</option>
28 <option value="lec">LEC</option>
29 <option value="louvain">LOUV</option>
30 <option value="leiden">LEID</option>
31 </param>
32 <param argument="--globalModel" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Global network null model" help="Perform global network null model analysis. The global network null model calculates the empirical p-value as the number of times (over a set of iterations) the size of the largest connected component (the giant component) in the network coming from the same number of randomly selected genes equals or exceeds the size of the largest connected component in the observed network. Default: Yes" />
33 <param argument="--globalIterations" type="integer" value="10" label="Global network null model iterations" help="Global network null model iterations. Recommended: 1000" />
34 <param argument="--globalNumber" type="integer" value="274" label="Global network model number of genes" help="Global network null model number of genes." />
35 <param argument="--localModel" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Local network null model" help="Perform local network null model analysis. The local network null model evaluates the deviation of modularity in the observed network from modularity distribution in the random network. Default: Yes" />
36 <param argument="--localIterations" type="integer" value="10" label="Local network null model iterations" help="Local network null model iterations. Recommended: 1000" />
37 <param argument="--networkPlot" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Network plot" help="Output the annotated graph of netboxr output. Default: Yes" />
38 <param argument="--plotWidth" type="integer" value="8" label="Network plot width" help="Plot width. Recommended: 9" />
39 <param argument="--outputSIF" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Network in SIF format" help="Output the network in SIF format. Default: Yes" />
40 <param argument="--neighborList" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Neighbor list" help="Output a table containing the information of all neighbor nodes. Default: Yes" />
41 <param argument="--modmem" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Module membership" help="Output a table containing the identified pathway module numbers. Default: Yes" />
42 <param argument="--nt" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Node type" help="Output a table containing the information of node types. Default: Yes" />
43 </inputs>
44 <outputs>
45 <data name="output_pdf" format="pdf" from_work_dir="network_plot.pdf" label="${tool.name} on ${on_string}: Network plot">
46 <filter>output_pdf is True</filter>
47 </data>
48 <data name="localModel_pdf" format="pdf" from_work_dir="localModel_histogram.pdf" label="${tool.name} on ${on_string}: Local model histogram">
49 <filter>localModel is True</filter>
50 </data>
51 <data name="output_sif" format="sif" from_work_dir="network.sif" label="${tool.name} on ${on_string}: SIF network">
52 <filter>outputSIF is True</filter>
53 </data>
54 <data name="output_neighbor" format="tabular" from_work_dir="neighbor_data.txt" label="${tool.name} on ${on_string}: Neighbor data">
55 <filter>output_neighbor is True</filter>
56 </data>
57 <data name="moduleMembership" format="tabular" from_work_dir="community.membership.txt" label="${tool.name} on ${on_string}: Module membership">
58 <filter>moduleMembership is True</filter>
59 </data>
60 <data name="nodeType" format="tabular" from_work_dir="nodeType.txt" label="${tool.name} on ${on_string}: Node type">
61 <filter>nodeType is True</filter>
62 </data>
63 <data name="metadata" format="txt" from_work_dir="metadata.txt" label="${tool.name} on ${on_string}: Metadata" />
64 </outputs>
65 <tests>
66 <test>
67 <param name="geneList" value="netbox2010_data.txt" />
68 <param name="cutoff" value="0.05" />
69 <param name="community" value="ebc" />
70 <param name="globalModel" value="True" />
71 <param name="globalIterations" value="10" />
72 <param name="globalNumber" value="274" />
73 <param name="localModel" value="True" />
74 <param name="localIterations" value="10" />
75 <param name="networkPlot" value="True" />
76 <param name="plotWidth" value="8" />
77 <param name="outputSIF" value="True" />
78 <param name="neighborList" value="True" />
79 <param name="modmem" value="True" />
80 <param name="nt" value="True" />
81 <output name="output_pdf" file="network_plot.pdf" compare="sim_size" />
82 <output name="localModel_pdf" file="localModel_histogram.pdf" compare="sim_size" />
83 <output name="output_sif" file="network.sif">
84 <assert_contents>
85 <has_text_matching expression="CBL\tPP\tPIK3R1" />
86 <has_text_matching expression="PIK3R1\tIN_SAME_COMPONENT\tAGAP2" />
87 </assert_contents>
88 </output>
89 <output name="output_neighbor" file="neighbor_data.txt">
90 <assert_contents>
91 <has_text_matching expression="idx\tname\tlocalDegree\tglobalDegree\tpValueRaw\toddsRatio\tpValueFDR" />
92 <has_text_matching expression="1712\tCRK\t11\t81\t2.39208791593171e-05\t1.70873218314362\t0.0186673141177578" />
93 <has_text_matching expression="6187\tRPS27\t2\t186\t0.975923212389053\t-0.825808759394024\t0.975923212389053" />
94 </assert_contents>
95 </output>
96 <output name="moduleMembership" file="community.membership.txt">
97 <assert_contents>
98 <has_text_matching expression="CBL\t1" />
99 <has_text_matching expression="CCT6A\t10" />
100 </assert_contents>
101 </output>
102 <output name="nodeType" file="nodeType.txt">
103 <assert_contents>
104 <has_text_matching expression="CDKN2B\tcandidate" />
105 <has_text_matching expression="PTPN11\tlinker" />
106 </assert_contents>
107 </output>
108 </test>
109 </tests>
110 <help><![CDATA[
111
112 NetBox is a network-based approach that combines prior knowledge with a
113 network clustering algorithm. The algorithm allows for the identification
114 of functional modules and allows for combining multiple data types, such as
115 mutations and copy number alterations. NetBox performs network analysis on
116 human interaction networks, and comes pre-loaded with a Human Interaction
117 Network (HIN) derived from four literature curated data sources, including
118 the Human Protein Reference Database (HPRD), Reactome, NCI-Nature Pathway
119 Interaction (PID) Database, and the MSKCC Cancer Cell Map.
120
121 -----
122
123 **INPUTS**
124
125 **Gene list**
126 A newline-delimited text file that contains a list of genes of interest is
127 required.
128
129 Example of text file contents:
130
131 EGFR
132 TP53
133 ACTB
134 GAPDH
135
136 **Cutoff value**
137 The corrected p-value (or q-value) cut-off to apply for the graph output.
138 The default p-value is 0.05.
139
140
141 **OUTPUTS**
142
143 * A PDF with a plot of the edge annotated graph (optional)
144
145 * A text file with tabular data containing information of all neighbor nodes (optional)
146
147 ]]></help>
148 <citations>
149 <citation type="doi">10.1371/journal.pone.0234669</citation>
150 </citations>
151 </tool>