about summary refs log tree commit diff
diff options
context:
space:
mode:
authorArun Isaac2026-08-13 16:42:08 +0100
committerArun Isaac2026-08-13 16:42:08 +0100
commit185b459cc11a2e8661817f2750d98f9051541761 (patch)
treefbd9f98095fc5b340b8671050eee695332ca5b73
parentb35f8cf1054912282dfea938c35e1c5949d2cba6 (diff)
downloaddomagi-185b459cc11a2e8661817f2750d98f9051541761.tar.gz
domagi-185b459cc11a2e8661817f2750d98f9051541761.tar.lz
domagi-185b459cc11a2e8661817f2750d98f9051541761.zip
Add short_help for subcommands.
-rw-r--r--domagi/domagi.py16
1 files changed, 8 insertions, 8 deletions
diff --git a/domagi/domagi.py b/domagi/domagi.py
index a38581a..c9d3ee2 100644
--- a/domagi/domagi.py
+++ b/domagi/domagi.py
@@ -66,7 +66,7 @@ def read_sql(filename):
 def main():
     pass
 
-@main.command()
+@main.command(short_help="Convert GFA pangenome file to domagi DuckDB database")
 @click.option("-g", "--gfa", "gfa",
               metavar="FILE",
               required=True,
@@ -86,7 +86,7 @@ def build(gfa, db, threads):
     with connect_duckdb(db, threads) as con:
         con.execute(read_sql("post-import.sql"))
 
-@main.command()
+@main.command(short_help="Crush runs of Ns")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,
@@ -116,7 +116,7 @@ def crush(con, outfile, threads):
       ORDER BY path_id, start, "end"
     """)
 
-@main.command()
+@main.command(short_help="Compute depth of graph nodes")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,
@@ -159,7 +159,7 @@ def depth(con, graph_depth_table, paths, bed_input, threads):
             # The start is always 0.
             print("\t".join([path_name, str(0), str(end), str(mean_depth)]))
 
-@main.command()
+@main.command(short_help="Extract subgraphs")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,
@@ -244,7 +244,7 @@ def extract(con, outfile, segment_name, path_range, steps, threads):
     """)
 
 # TODO: Add synopses for commands.
-@main.command()
+@main.command(short_help="Write graph in sparse matrix format")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,
@@ -257,7 +257,7 @@ def matrix(con, threads):
     print(segment_count, segment_count, df.shape[0])
     df.to_csv(sys.stdout, sep=" ", header=False, index=False)
 
-@main.command()
+@main.command(short_help="Interrogate paths")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,
@@ -285,7 +285,7 @@ def paths(con, list_paths, fasta, threads):
             print(f">{name}")
             print(sequence)
 
-@main.command()
+@main.command(short_help="Compute graph statistics")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,
@@ -306,7 +306,7 @@ def stats(con, summarize, threads):
     print("\t".join([str(length), str(nodes), str(edges),
                      str(paths), str(steps)]))
 
-@main.command()
+@main.command(short_help="Convert domagi DuckDB database pangenome to other formats")
 @click.option("-i", "--db", "--idx", "con",
               type=DuckDBParamType(),
               required=True,