.\" Copyright (c) 2014 Stijn van Dongen
.TH "clm vol" 1 "16 May 2014" "clm vol 14-137" "USER COMMANDS "
.po 2m
.de ZI
.\" Zoem Indent/Itemize macro I.
.br
'in +\\$1
.nr xa 0
.nr xa -\\$1
.nr xb \\$1
.nr xb -\\w'\\$2'
\h'|\\n(xau'\\$2\h'\\n(xbu'\\
..
.de ZJ
.br
.\" Zoem Indent/Itemize macro II.
'in +\\$1
'in +\\$2
.nr xa 0
.nr xa -\\$2
.nr xa -\\w'\\$3'
.nr xb \\$2
\h'|\\n(xau'\\$3\h'\\n(xbu'\\
..
.if n .ll -2m
.am SH
.ie n .in 4m
.el .in 8m
..
.SH NAME
clm_vol \- compute volatile nodes from a set of clusterings

clmvol is not in actual fact a program\&. This manual
page documents the behaviour and options of the clm program when
invoked in mode \fIvol\fP\&. The options \fB-h\fP, \fB--apropos\fP,
\fB--version\fP, \fB-set\fP, \fB--nop\fP are accessible
in all \fBclm\fP modes\&. They are described
in the \fBclm\fP manual page\&.
.SH SYNOPSIS

\fBclm vol\fP
\fB[-fraction\fP num (\fInff factor\fP)\fB]\fP
\fB[-o\fP fname (\fIoutput file\fP)\fB]\fP
<cl file>+
.SH DESCRIPTION

\fBclm vol\fP computes a score for each node, which at a minimum is equal to one\&.
The output is in the form of a matrix containing a single column\&. The score
correlates with what is deemed to be volatile behaviour\&. For all pairs of
clusterings the set of all intersections is computed, and these are
considered in turn\&.
An intersection is deemed to be volatile if the size of the intersection is
less than half the size of the smallest of the two clusters\&. In that case,
for each node in the intersection its volatility score is incremented by one
over the size of the intersection\&.
The size comparison can be made more stringent by increasing the
\fB-fraction\fP\ \&\fI<frac>\fP option, which is by default set to \fC0\&.5\fP\&.
Volatility occurs if the size of the intersection is less than
\fB<frac>\fP times the size of the smallest cluster\&. If the
\fB-fraction\fP value is increased all the way up to 1\&.0, the implication
is that an intersection is considered volatile unless one of the two
clusteres considered is a subset of the other\&.
.SH AUTHOR

Stijn van Dongen\&.
.SH OPTIONS

.ZI 2m "\fB-fraction\fP num (\fInff factor\fP)"
\&
.br
See the discussion at \fBDESCRIPTION\fP\&.
.in -2m

.ZI 2m "\fB-o\fP fname (\fIoutput file\fP)"
\&
.br
.in -2m
.SH SEE ALSO

\fBmclfamily(7)\fP for an overview of all the documentation
and the utilities in the mcl family\&.