feat: help text for workflow inputs

bento-platform · Dec 6, 2023 · 942d3cb · 942d3cb
1 parent a34eb9c
commit 942d3cb
Showing 1 changed file with 18 additions and 2 deletions.
diff --git a/bento_reference_service/workflows/metadata.py b/bento_reference_service/workflows/metadata.py
@@ -26,8 +26,24 @@
             wm.WorkflowServiceUrlInput(id="reference_url", service_kind="reference"),
             wm.WorkflowConfigInput(id="validate_ssl", key="validate_ssl"),
             # User-specified
-            wm.WorkflowStringInput(id="genome_id"),
-            wm.WorkflowFileInput(id="genome_fasta", pattern=r"^.*\.(fa|fa.gz|fas|fas.gz|fasta|fasta.gz)$"),
+            wm.WorkflowStringInput(
+                id="genome_id", help="Standard unique ID for this genome; e.g., hg38, GRCH38, UrsMar_1.0."),
+            wm.WorkflowStringInput(
+                id="taxon_term_json",
+                help=(
+                    "Phenopackets-style JSON representation for an NCBITaxon ontology term; for example:"
+                    "<code>{\"id\":\"NCBITaxon:9606\",\"label\":\"Homo sapiens\"}</code> <br />"
+                    "<code>{\"id\":\"NCBITaxon:3847\",\"label\":\"Glycine max\"}</code> <br />"
+                    "<code>{\"id\":\"NCBITaxon:871304\",\"label\":\"Lymantria dispar asiatica\"}</code> <br />"
+                    "<code>{\"id\":\"NCBITaxon:7460\",\"label\":\"Apis mellifera\"}</code> <br />"
+                    "<code>{\"id\":\"NCBITaxon:29073\",\"label\":\"Ursus maritimus\"}</code>"
+                ),
+            ),  # NCBITaxon:#####
+            wm.WorkflowFileInput(
+                id="genome_fasta",
+                pattern=r"^.*\.(fa|fa.gz|fas|fas.gz|fasta|fasta.gz)$",
+                help="FASTA file for the reference genome, either gzipped or uncompressed.",
+            ),
         ],
     ),
 )