Mercurial > repos > iuc > mcl

annotate mcl.xml @ 0:575d8d44d1b3 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
author iuc
date Mon, 13 Jun 2022 17:34:00 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
1 <tool id="mcl" name="MCL" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
2 <description>Markov Cluster Algorithm for graphs</description>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
3 <macros>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
4 <token name="@TOOL_VERSION@">14.137</token>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
6 </macros>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
7 <xrefs>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
8 <xref type="bio.tools">mcl</xref>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
9 </xrefs>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
10 <requirements>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
11 <requirement type="package" version="@TOOL_VERSION@">mcl</requirement>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
12 </requirements>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
13 <version_command>mcl --version</version_command>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
14 <command detect_errors="aggressive">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
15 <![CDATA[
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
16
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
17 mcl '$input'
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
18 -I '$inflation'
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
19 $input_type_select.input_type
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
20 -V all -te \${GALAXY_SLOTS:-1}
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
21 $sum_loops
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
22 $discard_loops
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
23 #if $verbosity
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
24 #for $v in $verbosity
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
25 -v $v
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
26 #end for
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
27 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
28 #if $reweight
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
29 -c $reweight
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
30 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
31 #if $transform
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
32 #if $input_type_select.input_type == "--abc" or $input_type_select.input_type == "--sif"
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
33 -abc-tf '$transform'
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
34 #else if $input_type_select.input_type == ""
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
35 -tf '$transform'
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
36 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
37 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
38 #if $input_type_select.input_type == "--sif"
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
39 $input_type_select.expect_values
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
40 #else if $input_type_select.input_type == "" and $input_type_select.use_tab
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
41 -use-tab $input_type_select.use_tab
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
42 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
43 #if $pruning_options.cutoff
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
44 -P $pruning_options.cutoff
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
45 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
46 #if $pruning_options.selection_number
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
47 -S $pruning_options.selection_number
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
48 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
49 #if $pruning_options.recover_number
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
50 -R $pruning_options.recover_number
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
51 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
52 #if $pruning_options.recover_percentage
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
53 -pct $pruning_options.recover_percentage
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
54 #end if
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
55 -o '$output'
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
56
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
57 ]]>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
58 </command>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
59 <inputs>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
60 <conditional name="input_type_select">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
61 <param name="input_type" type="select" label="Input type">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
62 <option value="--abc" selected="true">Labeled</option>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
63 <option value="--sif">SIF</option>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
64 <option value="">Matrix</option>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
65 </param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
66 <when value="">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
67 <param type="data" format="tabular" name="use_tab" argument="-use-tab" label="tabular label input" optional="true" help="use tab file to convert the output to labels"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
68 </when>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
69 <when value="--sif">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
70 <param type="boolean" name="expect_values" checked="false" truevalue="--expect-values" falsevalue="" argument="--expect-values" label="expect label:weight format" optional="true" help="accept extended SIF (label:weight fields)" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
71 </when>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
72 <when value="--abc" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
73 </conditional>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
74 <param type="data" format="txt,tabular,sif" name="input" label="Input" optional="false" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
75 <param name="inflation" argument="-I" type="float" value="2.0" label="Inflation" min="1" max="6" help="This value is the main handle for affecting cluster granularity. It is usually chosen somewhere in the range [1.2-5.0]. -I 5.0 will tend to result in fine-grained clusterings, and -I 1.2 will tend to result in very coarse grained clusterings. Your mileage will vary depending on the characteristics of your data. That is why it is a good idea to test the quality and coherency of your clusterings using clm dist and clm info. This will most likely reveal that certain values of -I are simply not right for your data." />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
76 <param name="transform" type="text" area="true" label="Transform input matrix values" help="See https://micans.org/mcl/man/mcxio.html#trans for the transformation syntax" >
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
77 <sanitizer>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
78 <valid initial="default">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
79 <add value="#" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
80 </valid>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
81 </sanitizer>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
82 </param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
83 <param argument="--discard-loops" type="boolean" checked="true" truevalue="--discard-loops=y" falsevalue="--discard-loops=n" label="Discard loops in input" help="Remove any loops that are present in the input. Bear in mind that loops will still be modified in all cases where the loop weight is not maximal among the list of edge weights for a given node." />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
84 <param name="reweight" argument="-c" optional="true" type="float" value="1" label="Reweight loops" help="As the final step of loop computation (i.e. after initialization and shadowing) all loop weights are multiplied by the provided value." />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
85 <param type="boolean" checked="false" truevalue="--sum-loops" falsevalue="" argument="--sum-loops" label="Set loops to sum of other arcs weights" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
86 <param name="verbosity" type="select" multiple="true" optional="true" label="Verbosity">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
87 <option value="pruning">pruning</option>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
88 <option value="explain">explain</option>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
89 <option value="cls">cls</option>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
90 </param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
91 <section title="Pruning options" name="pruning_options">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
92 <param name="cutoff" type="integer" value="4000" label="cutoff" argument="-P" optional="true" help="inverse cutoff pruning value. Entries smaller than cutoff are removed"></param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
93 <param name="selection_number" type="integer" value="500" label="selection number" argument="-S" optional="true" help="pruning selection value. maximum number of entries (if applicable)"></param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
94 <param name="recover_number" type="integer" value="600" label="recover number" argument="-R" optional="true" help="Pruning recover number. Revover the largest discarded entries during pruning, if number of entries less then -R"></param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
95 <param name="recover_percentage" type="integer" value="90" label="recover percentage" argument="-pct" min="0" max="100" optional="true" help="Pruning recover percentage. Revover the largest discarded entries during pruning, if sum of remaining entries is less than -pct/100"></param>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
96 </section>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
97 </inputs>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
98 <outputs>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
99 <data format="tabular" name="output" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
100 </outputs>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
101 <tests>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
102 <test expect_num_outputs="1">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
103 <param name="input" value="mcl-simple.tabular" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
104 <conditional name="input_type_select">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
105 <param name="input_type" value="--abc" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
106 </conditional>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
107 <param name="transform" value="gq(0.7),add(-0.7)" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
108 <param name="inflation" value="3"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
109 <output name="output" file="mcl-simple.out" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
110 </test>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
111 <test expect_num_outputs="1">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
112 <param name="input" value="mcl-simple.mci" ftype="txt" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
113 <conditional name="input_type_select">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
114 <param name="input_type" value="" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
115 <param name="use_tab" value="mcl-simple.mci.tab" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
116 </conditional>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
117 <param name="transform" value="gq(0.7),add(-0.7)" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
118 <param name="inflation" value="3"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
119 <output name="output" file="mcl-simple.out" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
120 </test>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
121 <test expect_num_outputs="1">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
122 <param name="input" value="mcl-simple.sif" ftype="sif" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
123 <conditional name="input_type_select">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
124 <param name="input_type" value="--sif" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
125 <param name="expect_values" value="true" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
126 </conditional>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
127 <param name="transform" value="gq(0.7),add(-0.7)" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
128 <param name="inflation" value="3"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
129 <output name="output" file="mcl-simple.out" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
130 </test>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
131 <test expect_num_outputs="1">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
132 <param name="input" value="mcl-simple.tabular" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
133 <conditional name="input_type_select">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
134 <param name="input_type" value="--abc" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
135 </conditional>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
136 <param name="cutoff" value="1"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
137 <param name="recover_number" value="1"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
138 <param name="selection_number" value="1"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
139 <param name="discard_loops" value="false"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
140 <param name="reweight" value="0.5"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
141 <param name="sum_loops" value="true"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
142 <output name="output" file="mcl-simple-pruning.out" ftype="tabular" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
143 </test>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
144 <test>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
145 <param name="input" value="mcl-simple.mci" ftype="txt" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
146 <conditional name="input_type_select">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
147 <param name="input_type" value="" />
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
148 </conditional>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
149 <output name="output" file="mcl-simple.mci-no-tab.out" ftype="tabular" lines_diff="2"/>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
150 </test>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
151 </tests>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
152 <help>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
153 <![CDATA[
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
154 **What it does**
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
155
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
156 The `Markov Cluster Algorithm`_, aka the MCL algorithm.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
157
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
158 The MCL algorithm is short for the Markov Cluster Algorithm, a fast and scalable unsupervised cluster algorithm for graphs (also known as networks) based on simulation of (stochastic) flow in graphs. It has found usage in bioinformatics and other disciplines.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
159
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
160 The MCL algorithm finds cluster structure in graphs by a mathematical bootstrapping procedure. The process deterministically computes (the probabilities of) random walks through the graph, and uses two operators transforming one set of probabilities into another. It does so using the language of stochastic matrices (also called Markov matrices) which capture the mathematical concept of random walks on a graph.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
161
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
162 The MCL algorithm simulates random walks within a graph by alternation of two operators called expansion and inflation. Expansion coincides with taking the power of a stochastic matrix using the normal matrix product (i.e. matrix squaring). Inflation corresponds with taking the Hadamard power of a matrix (taking powers entrywise), followed by a scaling step, such that the resulting matrix is stochastic again, i.e. the matrix elements (on each column) correspond to probability values.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
163
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
164 The basic interface to the algorithm is very simple - you need only one option (the -I flag) to get to the heart of it. The number of clusters cannot be specified. It is implicitly controlled using the inflation parameter. Inflation affects the granularity or resolution of the clustering outcome, with low values (1.3, 1.4) leading to fewer and larger clusters and high values (5, 6) leading to more and smaller clusters; the default value of 2 is a good starting point. For large graphs you should also be aware of the pruning options for regulating resources.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
165
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
166 Network construction and reduction techniques should not be considered as part of a clustering algorithm. Nevertheless particular techniques may benefit particular methods or applications. In mcl many transformations are accessible through the *transform* option. It can be used for edge weight transformations and selection, as well as transformations that act on a graph as a whole. It is for example possible to remove edges with weight below 0.7 by issuing -tf 'gq(0.7)', where the quotes are necessary to prevent the shell from interpreting the parentheses. The option accepts more complicated sequences, such as -tf 'gq(0.7),add(-0.7)'. This causes all remaining edge weights to be shifted to the range [0-0.3], assuming that the input contains correlations. Many more transformations are supported, as documented in mcxio_.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
167
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
168 .. _Markov Cluster Algorithm: https://micans.org/mcl/man/mcl.html
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
169 .. _mcxio: https://micans.org/mcl/man/mcxio.html
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
170
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
171 **Input**
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
172
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
173 MCL supports a number of different input formats. The recommended wayis to use a labeled input (ABC-format) The input is then a file or stream in which each line encodes an edge in terms of two labels (the 'A' and the 'B') and a numerical value (the 'C'), all separated by white space. MCL also supports SIF format and exposes a native matrix representation, which is useful whenever other programs of the mcl-suite are used in tandem::
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
174
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
175 Labeled
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
176 This simple format expects two or three fields separated by white space on each line. The first and sec-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
177 ond fields are interpreted as labels specifying source and destination node respectively. The third fie-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
178 ld, if present, specifies the weight of the arc connecting the two nodes.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
179
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
180 SIF
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
181 This option tells mcl to expect SIF (Simple Interaction File) format. This format is line based. The fi-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
182 rst two fields specify the source node (as a label) and the relationship type. An arbitrary number of f-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
183 ields may follow, each containing a label identifying a destination node. The second field is simply ig-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
184 nored by mcl. As an extension to the SIF format weights may optionally follow the labels, separated from
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
185 them with a colon character. It is in this case necessary to use the --expect-values option.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
186
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
187 --expect-values(expect label:weight format)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
188 accept extended SIF format (label:weight fields)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
189
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
190 Matrix
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
191 MCL internal matrix representation. See https://micans.org/mcl/man/mcxio.html#gspec for detailed informa.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
192 tion. Use -use-tab to write label output using dictionary file
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
193
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
194 -use-tab <fname> (use mapping to write)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
195 -use-tab is only useful when matrix input is used. It will use the tab file to convert the output to lab-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
196 els; it does not fail on indices missing from the tab file, but will bind these to generated dummy labels.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
197
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
198 **Options**::
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
199
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
200 -I <num> (inflation)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
201 Sets the main inflation value to <num>. This value is the main handle for affecting cluster granularity.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
202 It is usually chosen somewhere in the range [1.2-5.0]. -I 5.0 will tend to result in fine-grained clust-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
203 erings, and -I 1.2 will tend to result in very coarse grained clusterings. Your mileage will vary depen-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
204 ding on the characteristics of your data.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
205
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
206 -tf <tf-spec> (transform)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
207 transforms the values of the input matrix according to <tf-spec>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
208
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
209 -c <num> (reweight loops)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
210 increase loop-weights <num>-fold
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
211 --sum-loops (set loops to sum of other arcs weights)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
212 with the -c <num> option, as the final step of loop computation (i.e. after initialization and shadowing)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
213 all loop weights are multiplied by <num>, if supplied.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
214
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
215 --discard-loops=<y/n> (discard loops in input)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
216 By default mcl will remove any loops that are present in the input. Use --discard-loops=n to turn this
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
217 off. Bear in mind that loops will still be modified in all cases where the loop weight is not maximal a-
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
218 mong the list of edge weights for a given node.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
219
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
220 **Pruning options**
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
221
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
222 After computing a new (column stochastic) matrix vector during expansion (which is matrix multiplication c.q. squaring), the vector is successively exposed to different pruning strategies.The intent of pruning is that many small entries are removed while retaining much of the stochastic mass of the original vector. After pruning, vectors are rescaled to be stochastic again.MCL iterands are theoretically known to be sparse in a weighted sense, and this manoever effectively perturbs the MCL process a little in order to obtain matrices that are genuinely sparse, thus keeping the computation tractable.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
223
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
224 mcl proceeds as follows. First, entries that are smaller than cutoff are removed, resulting in a vector with at most 1/cutoff entries. The cutoff can be supplied as the inverse value (1/cutoff) by **-P**.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
225
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
226 Second, if the remaining stochastic mass (i.e. the sum of all remaining entries) is less than <pct>/100 (specified by the **-pct** flag) and the number of remaining entries is less than <r> (as specified by the **-R** flag), mcl will try to regain ground by recovering the largest discarded entries. The total number of entries is not allowed to grow larger than <r>. If recovery was not necessary, mcl tries to prune the vector further down to at most s entries (if applicable), as specified by the **-S** flag. If this results in a vector that satisfies the recovery condition then recovery is attempted, exactly as described above. The latter will not occur of course if <r> <= <s>.::
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
227
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
228 -P <int> (1/cutoff)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
229 (inverted) rigid pruning threshold
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
230
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
231 -S <int> (selection number)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
232 select down to <int> entries if needed
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
233
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
234 -R <int> (recover number)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
235 recover to maximally <int> entries if needed
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
236
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
237 -pct <pct> (recover percentage)
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
238 try recovery if mass is less than <pct>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
239
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
240 **Output**
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
241
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
242 The output is then a file where each line is a cluster of tab-separated labels.
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
243
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
244
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
245 ]]>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
246 </help>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
247 <citations>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
248 <citation type="doi">10.5281/zenodo.3364789</citation>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
249 <citation type="bibtex">
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
250 <![CDATA[
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
251 @article{dongen29graph,
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
252 title={Graph Clustering by Flow Simulation. 2000},
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
253 author={Dongen, SV},
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
254 journal={Domplein},
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
255 volume={29},
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
256 pages={3512}
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
257 }
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
258 ]]>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
259 </citation>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
260 <citation type="doi">10.1093/nar/30.7.1575</citation>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
261 </citations>
575d8d44d1b3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/mcl commit 6fcfaa3d5fefc854ec7398c2848e8db669593b71
iuc
parents:
diff changeset
262 </tool>