Merge pull request #241 from benjeffery/gene-cli

Add help to annotations CLI
tskit-dev · Dec 8, 2024 · ac29096 · ac29096
2 parents 793faad + bbb1e8f
commit ac29096
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/tsbrowse/__main__.py b/tsbrowse/__main__.py
@@ -49,7 +49,13 @@ def cli():
 
 @cli.command()
 @click.argument("path", type=click.Path(exists=True, dir_okay=False))
-@click.option("--annotations-file", type=click.Path(exists=True, dir_okay=False))
+@click.option(
+    "--annotations-file",
+    type=click.Path(exists=True, dir_okay=False),
+    help="Path to a csv annotations file containing no header and information "
+    "about each gene on a row in the order: "
+    "`chr,start,end,strand,ensembl ID,gene name`",
+)
 @click.option("--port", default=8080, help="Port to serve on")
 @click.option(
     "--show/--no-show",