build based on 33cc9df

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-12T06:54:35","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-12T07:17:30","documenter_version":"1.2.1"}}

dev/export.html

@@ -17,4 +17,4 @@
                  pools::Union{ObjectPools, Nothing}=nothing,
                  mincompsize::Union{Integer, Nothing}=nothing,
                  exported_sinks::AbstractVector{<:Integer}=sinks
-) -&gt; NamedTuple</code></pre><p>Cuts the <code>tree</code> at <code>threshold</code> and exports the resulting SCC network as the collection of dataframes.</p><p>If specified, calculates the flows from <code>sources</code> to <code>sinks</code> and returns them as additional edges.</p><p><strong>Keyword arguments</strong></p><ul><li><code>orig_diedges::AbstractDataFrame</code>: optional collection of the original edges. The metadata from this frame is added to the overlapping diedges of the SCC network.</li><li><code>vertices_stats::AbstractDataFrame</code>: optional vertices statistics</li><li><code>diedges_stats::AbstarctDataFrame</code>: optional directed edges statistics</li><li><code>flowpaths::Symbol</code>: how the flows should be traced<ul><li><code>skip</code> (default): no tracing</li><li><code>flowattr</code>: trace the flows (see <a href="source_sink.html#HierarchicalHotNet.traceflows"><code>HierarchicalHotNet.traceflows</code></a>) and add as <code>flowpaths</code> column to <em>diedges</em> data frame</li><li><code>steps</code>: trace the flows (see <a href="source_sink.html#HierarchicalHotNet.traceflows"><code>HierarchicalHotNet.traceflows</code></a>) and add as extra diedges of type <code>step</code> to <em>diedges</em> data frame</li></ul></li></ul><p><strong>Returns</strong></p><p>Named tuple with fields</p><ul><li><code>components::DataFrame</code>: statistics for <em>Strongly Connected Components</em></li><li><code>vertices::DataFrame</code>: network vertices</li><li><code>diedges::DataFrame</code>: directed edges</li><li><code>edges::DataFrame</code>: undirected edges</li></ul><p><strong>See also</strong></p><p><a href="scctree.html#HierarchicalHotNet.cut"><code>HierarchicalHotNet.cut</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/alyst/HierarchicalHotNet.jl/blob/b7252bbf252a00e31c37d004593624aee479b8d2/src/graph_export.jl#L1-L48">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="stats.html">« Statistics</a><a class="docs-footer-nextpage" href="utils.html">Utilities »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 06:54">Friday 12 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+) -&gt; NamedTuple</code></pre><p>Cuts the <code>tree</code> at <code>threshold</code> and exports the resulting SCC network as the collection of dataframes.</p><p>If specified, calculates the flows from <code>sources</code> to <code>sinks</code> and returns them as additional edges.</p><p><strong>Keyword arguments</strong></p><ul><li><code>orig_diedges::AbstractDataFrame</code>: optional collection of the original edges. The metadata from this frame is added to the overlapping diedges of the SCC network.</li><li><code>vertices_stats::AbstractDataFrame</code>: optional vertices statistics</li><li><code>diedges_stats::AbstarctDataFrame</code>: optional directed edges statistics</li><li><code>flowpaths::Symbol</code>: how the flows should be traced<ul><li><code>skip</code> (default): no tracing</li><li><code>flowattr</code>: trace the flows (see <a href="source_sink.html#HierarchicalHotNet.traceflows"><code>HierarchicalHotNet.traceflows</code></a>) and add as <code>flowpaths</code> column to <em>diedges</em> data frame</li><li><code>steps</code>: trace the flows (see <a href="source_sink.html#HierarchicalHotNet.traceflows"><code>HierarchicalHotNet.traceflows</code></a>) and add as extra diedges of type <code>step</code> to <em>diedges</em> data frame</li></ul></li></ul><p><strong>Returns</strong></p><p>Named tuple with fields</p><ul><li><code>components::DataFrame</code>: statistics for <em>Strongly Connected Components</em></li><li><code>vertices::DataFrame</code>: network vertices</li><li><code>diedges::DataFrame</code>: directed edges</li><li><code>edges::DataFrame</code>: undirected edges</li></ul><p><strong>See also</strong></p><p><a href="scctree.html#HierarchicalHotNet.cut"><code>HierarchicalHotNet.cut</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/alyst/HierarchicalHotNet.jl/blob/33cc9df0bca54ee0b492e9e681ec7c4539bb25d6/src/graph_export.jl#L1-L48">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="stats.html">« Statistics</a><a class="docs-footer-nextpage" href="utils.html">Utilities »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 07:17">Friday 12 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>