Update cmd_access.py #120 #121

draeger-lab · Jul 15, 2024 · a84509b · a84509b
1 parent b1c9d1e
commit a84509b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/refinegems/cmd_access.py b/src/refinegems/cmd_access.py
@@ -162,6 +162,16 @@ def gaps():
 # Find gaps via genes
 # -------------------     
 def get_gap_analysis_input(db_to_compare: Literal['KEGG', 'BioCyc']) -> dict:
+   """Form to retrieve input files for :py:func:`~refinegems.curation.gapfill.gap_analysis`
+
+   Args:
+       - db_to_compare (Literal['KEGG', 'BioCyc']): 
+           Database to compare model content to
+
+   Returns:
+       dict: 
+           Input dictionary for :py:func:`~refinegems.curation.gapfill.gap_analysis`
+   """
 
    parameters2inputs = {'organismid': None, 'gff_file': None, 'biocyc_files': None}