about summary refs log tree commit diff
path: root/doc/domagi-stats.dbk
diff options
context:
space:
mode:
authorArun Isaac2026-08-13 22:13:01 +0100
committerArun Isaac2026-08-13 22:13:01 +0100
commit439ada732261b76816dddc236ee41cca651a0c14 (patch)
treefefe0f4259927008817d1a66e01bba11ff758e87 /doc/domagi-stats.dbk
parent350ddbf6fc2acbc2b27aa7a4fbc8de491c95fa68 (diff)
downloaddomagi-439ada732261b76816dddc236ee41cca651a0c14.tar.gz
domagi-439ada732261b76816dddc236ee41cca651a0c14.tar.lz
domagi-439ada732261b76816dddc236ee41cca651a0c14.zip
Add manual.
Diffstat (limited to 'doc/domagi-stats.dbk')
-rw-r--r--doc/domagi-stats.dbk20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/domagi-stats.dbk b/doc/domagi-stats.dbk
new file mode 100644
index 0000000..5b9d620
--- /dev/null
+++ b/doc/domagi-stats.dbk
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
+  <xi:include href="gen-refentry-stats.xml" />
+  <refsection>
+    <title>Description</title>
+    <para>Compute variation graph statistics. Among other metrics, it can compute the number nodes, the number of edges, the number of paths and the total nucleotide length of the graph.</para>
+    <variablelist>
+      <title>Options</title>
+      <xi:include href="input-db-argument.dbk" />
+      <varlistentry>
+        <term><option>-S</option></term>
+        <term><option>--summarize</option></term>
+        <listitem><para>Summarize the graph properties. Output is printed in a five-column tab-delimited format with the following columns—the number of nucleotides, the number of segments, the number of links, the number of paths, and the number of steps. The number of nucleotides is the total number across all segments of the graph. The number of steps is the total number of segments traversed by all paths in the pangenome. Segments that are traversed more than once are counted multiple times.</para></listitem>
+      </varlistentry>
+      <xi:include href="threads-argument.dbk" />
+      <xi:include href="help-option.dbk" />
+    </variablelist>
+  </refsection>
+</refentry>