Skip to content

Commit 33cc9df

Browse files
committed
[*] docs/source_sink: simplify metric explanation
1 parent b7252bb commit 33cc9df

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/src/source_sink.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ based on the reshuffled node weights.
2323

2424
## [Network Metrics](@id network_metrics)
2525

26-
It's is important to have a way to check the relevance of *HierarchicalHotNet* predictions.
26+
It is important to have a way to check the relevance of *HierarchicalHotNet* predictions.
2727
For example, one can [randomize the input data](@ref permweights) and show that, at some edge weight
2828
threshold ``t_*``, *HHotNet* predictions based on the real data, ``H(\mathcal{D}_{\mathrm{real}}, t_*)``,
29-
demnostrate significantly more order than the ones based on randomized data,
30-
``H(\mathcal{D}_{\mathrm{perm}}^i, t_*)``, ``i=1,2,\ldots,N_{\mathrm{perm}}``.
31-
If the "order" could be expressed as some metric ``m(H)``, then we can easily define
29+
demnostrate significantly more "order" than the ones based on randomized data,
30+
``H(\mathcal{D}_{\mathrm{perm}}, t_*)``.
31+
If the "order" could be expressed as some metric ``m(H)``, then we can define
3232
the ``p``-value for the hypothesis that ``H(\mathcal{D}_{\mathrm{real}}, t)`` is significantly
3333
more "ordered" than expected by chance:
3434
```math
35-
p_m(H(\mathcal{D}_{\mathrm{real}}, t)) = P\big(M_{\mathrm{perm}}(t) \geq m(H(\mathcal{D}_{\mathrm{real}}, t)) \big),
35+
p_m(H(\mathcal{D}_{\mathrm{real}}, t)) = P\big(m(H(\mathcal{D}_{\mathrm{perm}}, t_*)) \geq m(H(\mathcal{D}_{\mathrm{real}}, t)) \big).
3636
```
37-
where ``M_{\mathrm{perm}}(t)`` is a random variable derived from the empirical distribution
38-
of ``m(H(\mathcal{D}_{\mathrm{perm}}^i, t))``, ``i = 1, 2, \ldots, N_{\mathrm{perm}}``.
39-
The definition above was given for the case of ``m(H)`` growing with the increase of ``H`` "order".
40-
If the metric ``m`` decreases as the "order" of ``H`` grows, ``P(M \geq m(H))`` should be changed
37+
``p_m`` could be approximated by generating a family *HHotNet* prediction based on randomized data,
38+
``H(\mathcal{D}_{\mathrm{perm}}^i, t))``, ``i = 1, 2, \ldots, N_{\mathrm{perm}}``.
39+
The definition above was given for the metric ``m(H)`` that increases as ``H`` becomes more "ordered".
40+
If the metric ``m(H)`` decreases as the "order" of ``H`` grows, ``P(M \geq m(H))`` should be changed
4141
to ``P(M \leq m(H))``.
4242

4343
In [_M.A. Reyna et al_ (2018)](https://academic.oup.com/bioinformatics/article/34/17/i972/5093236),

0 commit comments

Comments
 (0)