Skip to content

Commit dbcc83f

Browse files
committed
Enhance docstring
1 parent 6bc97bd commit dbcc83f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

publication_runs/ecoli_models/create_reaction_id_to_dG0_mapping_json.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,15 @@ def create_reaction_id_to_dG0_mapping_json(model: cobra.Model, json_path: str) -
3030
lets the Equilibrator API calculate the dG0 values for each reaction using
3131
the MetaNetX IDs for the metabolites.
3232
33+
This function is specifically written for the E. coli models used in CommModelPy's
34+
publication as its selection of dG0 values is based on BiGG identifiers and as it
35+
contains specific dG0 corrections for special reactions as referenced in the
36+
comments of this function.
37+
However, the general basis of this function can be easily adapted for other types of models.
38+
3339
Arguments:
3440
* model: cobra.Model ~ The cobrapy model instance for which the dG0 mapping shall be created.
35-
* json_path: str ~
41+
* json_path: str ~ The path to the dG0 JSON that is going to be created.
3642
3743
Output:
3844
* No variable but a JSON file with the mapping at json_path

0 commit comments

Comments
 (0)