annotate COBRAxy/utils/model_utils.py @ 492:4ed95023af20 draft

Uploaded
author francesco_lapi
date Tue, 30 Sep 2025 14:02:17 +0000
parents c6ea189ea7e9
children a92d21f92956
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
1 """
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
2 Utilities for generating and manipulating COBRA models and related metadata.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
3
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
4 This module includes helpers to:
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
5 - extract rules, reactions, bounds, objective coefficients, and compartments
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
6 - build a COBRA model from a tabular file
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
7 - set objective and medium from dataframes
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
8 - validate a model and convert gene identifiers
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
9 - translate model GPRs using mapping tables
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
10 """
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
11 import os
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
12 import cobra
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
13 import pandas as pd
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
14 import re
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
15 import logging
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
16 from typing import Optional, Tuple, Union, List, Dict, Set
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
17 from collections import defaultdict
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
18 import utils.rule_parsing as rulesUtils
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
19 import utils.reaction_parsing as reactionUtils
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
20 from cobra import Model as cobraModel, Reaction, Metabolite
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
21 import sys
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
22
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
23
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
24 ############################ check_methods ####################################
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
25 def gene_type(l :str, name :str) -> str:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
26 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
27 Determine the type of gene ID.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
28
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
29 Args:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
30 l (str): The gene identifier to check.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
31 name (str): The name of the dataset, used in error messages.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
32
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
33 Returns:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
34 str: The type of gene ID ('hugo_id', 'ensembl_gene_id', 'symbol', or 'entrez_id').
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
35
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
36 Raises:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
37 sys.exit: If the gene ID type is not supported, the execution is aborted.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
38 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
39 if check_hgnc(l):
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
40 return 'hugo_id'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
41 elif check_ensembl(l):
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
42 return 'ensembl_gene_id'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
43 elif check_symbol(l):
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
44 return 'symbol'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
45 elif check_entrez(l):
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
46 return 'entrez_id'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
47 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
48 sys.exit('Execution aborted:\n' +
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
49 'gene ID type in ' + name + ' not supported. Supported ID'+
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
50 'types are: HUGO ID, Ensemble ID, HUGO symbol, Entrez ID\n')
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
51
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
52 def check_hgnc(l :str) -> bool:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
53 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
54 Check if a gene identifier follows the HGNC format.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
55
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
56 Args:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
57 l (str): The gene identifier to check.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
58
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
59 Returns:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
60 bool: True if the gene identifier follows the HGNC format, False otherwise.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
61 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
62 if len(l) > 5:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
63 if (l.upper()).startswith('HGNC:'):
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
64 return l[5:].isdigit()
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
65 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
66 return False
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
67 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
68 return False
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
69
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
70 def check_ensembl(l :str) -> bool:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
71 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
72 Check if a gene identifier follows the Ensembl format.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
73
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
74 Args:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
75 l (str): The gene identifier to check.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
76
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
77 Returns:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
78 bool: True if the gene identifier follows the Ensembl format, False otherwise.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
79 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
80 return l.upper().startswith('ENS')
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
81
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
82
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
83 def check_symbol(l :str) -> bool:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
84 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
85 Check if a gene identifier follows the symbol format.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
86
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
87 Args:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
88 l (str): The gene identifier to check.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
89
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
90 Returns:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
91 bool: True if the gene identifier follows the symbol format, False otherwise.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
92 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
93 if len(l) > 0:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
94 if l[0].isalpha() and l[1:].isalnum():
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
95 return True
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
96 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
97 return False
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
98 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
99 return False
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
100
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
101 def check_entrez(l :str) -> bool:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
102 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
103 Check if a gene identifier follows the Entrez ID format.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
104
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
105 Args:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
106 l (str): The gene identifier to check.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
107
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
108 Returns:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
109 bool: True if the gene identifier follows the Entrez ID format, False otherwise.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
110 """
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
111 if len(l) > 0:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
112 return l.isdigit()
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
113 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
114 return False
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
115
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
116 ################################- DATA GENERATION -################################
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
117 ReactionId = str
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
118 def generate_rules(model: cobraModel, *, asParsed = True) -> Union[Dict[ReactionId, rulesUtils.OpList], Dict[ReactionId, str]]:
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
119 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
120 Generate a dictionary mapping reaction IDs to GPR rules from the model.
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
121
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
122 Args:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
123 model: COBRA model to derive data from.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
124 asParsed: If True, parse rules into a nested list structure; otherwise keep raw strings.
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
125
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
126 Returns:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
127 Dict[ReactionId, rulesUtils.OpList]: Parsed rules by reaction ID.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
128 Dict[ReactionId, str]: Raw rules by reaction ID.
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
129 """
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
130 _ruleGetter = lambda reaction : reaction.gene_reaction_rule
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
131 ruleExtractor = (lambda reaction :
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
132 rulesUtils.parseRuleToNestedList(_ruleGetter(reaction))) if asParsed else _ruleGetter
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
133
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
134 return {
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
135 reaction.id : ruleExtractor(reaction)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
136 for reaction in model.reactions
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
137 if reaction.gene_reaction_rule }
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
138
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
139 def generate_reactions(model :cobraModel, *, asParsed = True) -> Dict[ReactionId, str]:
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
140 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
141 Generate a dictionary mapping reaction IDs to reaction formulas from the model.
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
142
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
143 Args:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
144 model: COBRA model to derive data from.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
145 asParsed: If True, convert formulas into a parsed representation; otherwise keep raw strings.
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
146
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
147 Returns:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
148 Dict[ReactionId, str]: Reactions by reaction ID (parsed if requested).
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
149 """
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
150
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
151 unparsedReactions = {
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
152 reaction.id : reaction.reaction
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
153 for reaction in model.reactions
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
154 if reaction.reaction
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
155 }
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
156
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
157 if not asParsed: return unparsedReactions
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
158
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
159 return reactionUtils.create_reaction_dict(unparsedReactions)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
160
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
161 def get_medium(model:cobraModel) -> pd.DataFrame:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
162 """
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
163 Extract the uptake reactions representing the model medium.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
164
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
165 Returns a DataFrame with a single column 'reaction' listing exchange reactions
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
166 with negative lower bound and no positive stoichiometric coefficients (uptake only).
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
167 """
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
168 trueMedium=[]
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
169 for r in model.reactions:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
170 positiveCoeff=0
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
171 for m in r.metabolites:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
172 if r.get_coefficient(m.id)>0:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
173 positiveCoeff=1;
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
174 if (positiveCoeff==0 and r.lower_bound<0):
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
175 trueMedium.append(r.id)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
176
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
177 df_medium = pd.DataFrame()
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
178 df_medium["reaction"] = trueMedium
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
179 return df_medium
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
180
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
181 def extract_objective_coefficients(model: cobraModel) -> pd.DataFrame:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
182 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
183 Extract objective coefficients for each reaction.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
184
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
185 Args:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
186 model: COBRA model
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
187
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
188 Returns:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
189 pd.DataFrame with columns: ReactionID, ObjectiveCoefficient
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
190 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
191 coeffs = []
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
192 # model.objective.expression is a linear expression
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
193 objective_expr = model.objective.expression.as_coefficients_dict()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
194
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
195 for reaction in model.reactions:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
196 coeff = objective_expr.get(reaction.forward_variable, 0.0)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
197 coeffs.append({
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
198 "ReactionID": reaction.id,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
199 "ObjectiveCoefficient": coeff
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
200 })
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
201
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
202 return pd.DataFrame(coeffs)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
203
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
204 def generate_bounds(model:cobraModel) -> pd.DataFrame:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
205 """
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
206 Build a DataFrame of lower/upper bounds for all reactions.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
207
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
208 Returns:
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
209 pd.DataFrame indexed by reaction IDs with columns ['lower_bound', 'upper_bound'].
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
210 """
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
211
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
212 rxns = []
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
213 for reaction in model.reactions:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
214 rxns.append(reaction.id)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
215
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
216 bounds = pd.DataFrame(columns = ["lower_bound", "upper_bound"], index=rxns)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
217
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
218 for reaction in model.reactions:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
219 bounds.loc[reaction.id] = [reaction.lower_bound, reaction.upper_bound]
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
220 return bounds
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
221
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
222
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
223
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
224 def generate_compartments(model: cobraModel) -> pd.DataFrame:
418
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
225 """
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
226 Generates a DataFrame containing compartment information for each reaction.
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
227 Creates columns for each compartment position (Compartment_1, Compartment_2, etc.)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
228
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
229 Args:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
230 model: the COBRA model to extract compartment data from.
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
231
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
232 Returns:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
233 pd.DataFrame: DataFrame with ReactionID and compartment columns
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
234 """
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
235 pathway_data = []
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
236
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
237 # First pass: determine the maximum number of pathways any reaction has
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
238 max_pathways = 0
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
239 reaction_pathways = {}
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
240
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
241 for reaction in model.reactions:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
242 # Get unique pathways from all metabolites in the reaction
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
243 if type(reaction.annotation['pathways']) == list:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
244 reaction_pathways[reaction.id] = reaction.annotation['pathways']
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
245 max_pathways = max(max_pathways, len(reaction.annotation['pathways']))
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
246 else:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
247 reaction_pathways[reaction.id] = [reaction.annotation['pathways']]
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
248
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
249 # Create column names for pathways
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
250 pathway_columns = [f"Pathway_{i+1}" for i in range(max_pathways)]
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
251
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
252 # Second pass: create the data
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
253 for reaction_id, pathways in reaction_pathways.items():
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
254 row = {"ReactionID": reaction_id}
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
255
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
256 # Fill pathway columns
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
257 for i in range(max_pathways):
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
258 col_name = pathway_columns[i]
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
259 if i < len(pathways):
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
260 row[col_name] = pathways[i]
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
261 else:
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
262 row[col_name] = None # or "" if you prefer empty strings
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
263
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
264 pathway_data.append(row)
919b5b71a61c Uploaded
francesco_lapi
parents:
diff changeset
265
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
266 return pd.DataFrame(pathway_data)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
267
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
268
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
269
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
270 def build_cobra_model_from_csv(csv_path: str, model_id: str = "new_model") -> cobraModel:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
271 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
272 Build a COBRApy model from a tabular file with reaction data.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
273
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
274 Args:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
275 csv_path: Path to the tab-separated file.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
276 model_id: ID for the newly created model.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
277
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
278 Returns:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
279 cobra.Model: The constructed COBRApy model.
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
280 """
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
281
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
282 df = pd.read_csv(csv_path, sep='\t')
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
283
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
284 model = cobraModel(model_id)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
285
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
286 metabolites_dict = {}
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
287 compartments_dict = {}
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
288
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
289 print(f"Building model from {len(df)} reactions...")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
290
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
291 for idx, row in df.iterrows():
448
f8b1761eee37 Uploaded
francesco_lapi
parents: 444
diff changeset
292 reaction_formula = str(row['Formula']).strip()
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
293 if not reaction_formula or reaction_formula == 'nan':
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
294 continue
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
295
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
296 metabolites = extract_metabolites_from_reaction(reaction_formula)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
297
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
298 for met_id in metabolites:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
299 compartment = extract_compartment_from_metabolite(met_id)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
300
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
301 if compartment not in compartments_dict:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
302 compartments_dict[compartment] = compartment
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
303
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
304 if met_id not in metabolites_dict:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
305 metabolites_dict[met_id] = Metabolite(
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
306 id=met_id,
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
307 compartment=compartment,
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
308 name=met_id.replace(f"_{compartment}", "").replace("__", "_")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
309 )
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
310
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
311 model.compartments = compartments_dict
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
312
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
313 model.add_metabolites(list(metabolites_dict.values()))
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
314
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
315 print(f"Added {len(metabolites_dict)} metabolites and {len(compartments_dict)} compartments")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
316
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
317 reactions_added = 0
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
318 reactions_skipped = 0
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
319
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
320 for idx, row in df.iterrows():
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
321
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
322 reaction_id = str(row['ReactionID']).strip()
427
4a385fdb9e58 Uploaded
francesco_lapi
parents: 426
diff changeset
323 reaction_formula = str(row['Formula']).strip()
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
324
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
325 if not reaction_formula or reaction_formula == 'nan':
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
326 raise ValueError(f"Missing reaction formula for {reaction_id}")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
327
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
328 reaction = Reaction(reaction_id)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
329 reaction.name = reaction_id
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
330
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
331 reaction.lower_bound = float(row['lower_bound']) if pd.notna(row['lower_bound']) else -1000.0
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
332 reaction.upper_bound = float(row['upper_bound']) if pd.notna(row['upper_bound']) else 1000.0
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
333
427
4a385fdb9e58 Uploaded
francesco_lapi
parents: 426
diff changeset
334 if pd.notna(row['GPR']) and str(row['GPR']).strip():
4a385fdb9e58 Uploaded
francesco_lapi
parents: 426
diff changeset
335 reaction.gene_reaction_rule = str(row['GPR']).strip()
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
336
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
337 try:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
338 parse_reaction_formula(reaction, reaction_formula, metabolites_dict)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
339 except Exception as e:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
340 print(f"Error parsing reaction {reaction_id}: {e}")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
341 reactions_skipped += 1
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
342 continue
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
343
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
344 model.add_reactions([reaction])
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
345 reactions_added += 1
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
346
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
347
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
348 print(f"Added {reactions_added} reactions, skipped {reactions_skipped} reactions")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
349
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
350 # set objective function
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
351 set_objective_from_csv(model, df, obj_col="ObjectiveCoefficient")
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
352
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
353 set_medium_from_data(model, df)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
354
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
355 print(f"Model completed: {len(model.reactions)} reactions, {len(model.metabolites)} metabolites")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
356
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
357 return model
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
358
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
359
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
360 # Estrae tutti gli ID metaboliti nella formula (gestisce prefissi numerici + underscore)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
361 def extract_metabolites_from_reaction(reaction_formula: str) -> Set[str]:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
362 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
363 Extract metabolite IDs from a reaction formula.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
364 Robust pattern: tokens ending with _<compartment> (e.g., _c, _m, _e),
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
365 allowing leading digits/underscores.
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
366 """
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
367 metabolites = set()
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
368 # optional coefficient followed by a token ending with _<letters>
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
369 pattern = r'(?:\d+(?:\.\d+)?\s+)?([A-Za-z0-9_]+_[a-z]+)'
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
370 matches = re.findall(pattern, reaction_formula)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
371 metabolites.update(matches)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
372 return metabolites
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
373
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
374
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
375 def extract_compartment_from_metabolite(metabolite_id: str) -> str:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
376 """Extract the compartment from a metabolite ID."""
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
377 if '_' in metabolite_id:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
378 return metabolite_id.split('_')[-1]
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
379 return 'c' # default cytoplasm
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
380
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
381
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
382 def parse_reaction_formula(reaction: Reaction, formula: str, metabolites_dict: Dict[str, Metabolite]):
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
383 """Parse a reaction formula and set metabolites with their coefficients."""
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
384
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
385 if '<=>' in formula:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
386 left, right = formula.split('<=>')
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
387 reversible = True
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
388 elif '<--' in formula:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
389 left, right = formula.split('<--')
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
390 reversible = False
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
391 elif '-->' in formula:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
392 left, right = formula.split('-->')
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
393 reversible = False
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
394 elif '<-' in formula:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
395 left, right = formula.split('<-')
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
396 reversible = False
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
397 else:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
398 raise ValueError(f"Unrecognized reaction format: {formula}")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
399
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
400 reactants = parse_metabolites_side(left.strip())
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
401 products = parse_metabolites_side(right.strip())
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
402
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
403 metabolites_to_add = {}
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
404
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
405 for met_id, coeff in reactants.items():
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
406 if met_id in metabolites_dict:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
407 metabolites_to_add[metabolites_dict[met_id]] = -coeff
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
408
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
409 for met_id, coeff in products.items():
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
410 if met_id in metabolites_dict:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
411 metabolites_to_add[metabolites_dict[met_id]] = coeff
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
412
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
413 reaction.add_metabolites(metabolites_to_add)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
414
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
415
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
416 def parse_metabolites_side(side_str: str) -> Dict[str, float]:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
417 """Parse one side of a reaction and extract metabolites with coefficients."""
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
418 metabolites = {}
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
419 if not side_str or side_str.strip() == '':
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
420 return metabolites
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
421
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
422 terms = side_str.split('+')
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
423 for term in terms:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
424 term = term.strip()
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
425 if not term:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
426 continue
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
427
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
428 # optional coefficient + id ending with _<compartment>
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
429 match = re.match(r'(?:(\d+\.?\d*)\s+)?([A-Za-z0-9_]+_[a-z]+)', term)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
430 if match:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
431 coeff_str, met_id = match.groups()
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
432 coeff = float(coeff_str) if coeff_str else 1.0
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
433 metabolites[met_id] = coeff
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
434
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
435 return metabolites
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
436
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
437
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
438
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
439 def set_objective_from_csv(model: cobra.Model, df: pd.DataFrame, obj_col: str = "ObjectiveCoefficient"):
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
440 """
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
441 Sets the model's objective function based on a column of coefficients in the CSV.
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
442 Can be any reaction(s), not necessarily biomass.
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
443 """
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
444 obj_dict = {}
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
445
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
446 for idx, row in df.iterrows():
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
447 reaction_id = str(row['ReactionID']).strip()
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
448 coeff = float(row[obj_col]) if pd.notna(row[obj_col]) else 0.0
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
449 if coeff != 0:
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
450 if reaction_id in model.reactions:
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
451 obj_dict[model.reactions.get_by_id(reaction_id)] = coeff
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
452 else:
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
453 print(f"Warning: reaction {reaction_id} not found in model, skipping for objective.")
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
454
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
455 if not obj_dict:
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
456 raise ValueError("No reactions found with non-zero objective coefficient.")
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
457
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
458 model.objective = obj_dict
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
459 print(f"Objective set with {len(obj_dict)} reactions.")
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
460
f49c951c9fe6 Uploaded
francesco_lapi
parents: 427
diff changeset
461
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
462
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
463
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
464 def set_medium_from_data(model: cobraModel, df: pd.DataFrame):
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
465 """Set the medium based on the 'InMedium' column in the dataframe."""
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
466 medium_reactions = df[df['InMedium'] == True]['ReactionID'].tolist()
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
467
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
468 medium_dict = {}
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
469 for rxn_id in medium_reactions:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
470 if rxn_id in [r.id for r in model.reactions]:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
471 reaction = model.reactions.get_by_id(rxn_id)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
472 if reaction.lower_bound < 0: # Solo reazioni di uptake
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
473 medium_dict[rxn_id] = abs(reaction.lower_bound)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
474
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
475 if medium_dict:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
476 model.medium = medium_dict
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
477 print(f"Medium set with {len(medium_dict)} components")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
478
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
479
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
480 def validate_model(model: cobraModel) -> Dict[str, any]:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
481 """Validate the model and return basic statistics."""
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
482 validation = {
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
483 'num_reactions': len(model.reactions),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
484 'num_metabolites': len(model.metabolites),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
485 'num_genes': len(model.genes),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
486 'num_compartments': len(model.compartments),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
487 'objective': str(model.objective),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
488 'medium_size': len(model.medium),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
489 'reversible_reactions': len([r for r in model.reactions if r.reversibility]),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
490 'exchange_reactions': len([r for r in model.reactions if r.id.startswith('EX_')]),
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
491 }
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
492
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
493 try:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
494 # Growth test
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
495 solution = model.optimize()
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
496 validation['growth_rate'] = solution.objective_value
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
497 validation['status'] = solution.status
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
498 except Exception as e:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
499 validation['growth_rate'] = None
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
500 validation['status'] = f"Error: {e}"
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
501
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
502 return validation
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
503
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
504 def convert_genes(model, annotation):
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
505 """Rename genes using a selected annotation key in gene.notes; returns a model copy."""
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
506 from cobra.manipulation import rename_genes
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
507 model2=model.copy()
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
508 try:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
509 dict_genes={gene.id:gene.notes[annotation] for gene in model2.genes}
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
510 except:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
511 print("No annotation in gene dict!")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
512 return -1
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
513 rename_genes(model2,dict_genes)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 418
diff changeset
514
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
515 return model2
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
516
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
517 # ---------- Utility helpers ----------
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
518 def _normalize_colname(col: str) -> str:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
519 return col.strip().lower().replace(' ', '_')
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
520
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
521 def _choose_columns(mapping_df: 'pd.DataFrame') -> Dict[str, str]:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
522 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
523 Find useful columns and return a dict {ensg: colname1, hgnc_id: colname2, ...}.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
524 Raise ValueError if no suitable mapping is found.
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
525 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
526 cols = { _normalize_colname(c): c for c in mapping_df.columns }
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
527 chosen = {}
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
528 # candidate names for each category
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
529 candidates = {
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
530 'ensg': ['ensg', 'ensembl_gene_id', 'ensembl'],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
531 'hgnc_id': ['hgnc_id', 'hgnc', 'hgnc:'],
444
06564187fba3 Uploaded
francesco_lapi
parents: 430
diff changeset
532 'hgnc_symbol': ['hgnc_symbol', 'hgnc symbol', 'symbol'],
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
533 'entrez_id': ['entrez', 'entrez_id', 'entrezgene'],
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
534 'gene_number': ['gene_number']
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
535 }
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
536 for key, names in candidates.items():
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
537 for n in names:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
538 if n in cols:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
539 chosen[key] = cols[n]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
540 break
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
541 return chosen
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
542
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
543 def _validate_target_uniqueness(mapping_df: 'pd.DataFrame',
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
544 source_col: str,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
545 target_col: str,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
546 model_source_genes: Optional[Set[str]] = None,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
547 logger: Optional[logging.Logger] = None) -> None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
548 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
549 Check that, within the filtered mapping_df, each target maps to at most one source.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
550 Log examples if duplicates are found.
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
551 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
552 if logger is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
553 logger = logging.getLogger(__name__)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
554
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
555 if mapping_df.empty:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
556 logger.warning("Mapping dataframe is empty for the requested source genes; skipping uniqueness validation.")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
557 return
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
558
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
559 # normalize temporary columns for grouping (without altering the original df)
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
560 tmp = mapping_df[[source_col, target_col]].copy()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
561 tmp['_src_norm'] = tmp[source_col].astype(str).map(_normalize_gene_id)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
562 tmp['_tgt_norm'] = tmp[target_col].astype(str).str.strip()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
563
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
564 # optionally filter to the set of model source genes
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
565 if model_source_genes is not None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
566 tmp = tmp[tmp['_src_norm'].isin(model_source_genes)]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
567
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
568 if tmp.empty:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
569 logger.warning("After filtering to model source genes, mapping table is empty — nothing to validate.")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
570 return
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
571
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
572 # build reverse mapping: target -> set(sources)
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
573 grouped = tmp.groupby('_tgt_norm')['_src_norm'].agg(lambda s: set(s.dropna()))
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
574 # find targets with more than one source
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
575 problematic = {t: sorted(list(s)) for t, s in grouped.items() if len(s) > 1}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
576
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
577 if problematic:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
578 # prepare warning message with examples (limited subset)
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
579 sample_items = list(problematic.items())
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
580 msg_lines = ["Mapping validation failed: some target IDs are associated with multiple source IDs."]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
581 for tgt, sources in sample_items:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
582 msg_lines.append(f" - target '{tgt}' <- sources: {', '.join(sources)}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
583 full_msg = "\n".join(msg_lines)
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
584 # log warning
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
585 logger.warning(full_msg)
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
586
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
587 # if everything is fine
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
588 logger.info("Mapping validation passed: no target ID is associated with multiple source IDs (within filtered set).")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
589
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
590
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
591 def _normalize_gene_id(g: str) -> str:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
592 """Normalize a gene ID for use as a key (removes prefixes like 'HGNC:' and strips)."""
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
593 if g is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
594 return ""
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
595 g = str(g).strip()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
596 # remove common prefixes
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
597 g = re.sub(r'^(HGNC:)', '', g, flags=re.IGNORECASE)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
598 g = re.sub(r'^(ENSG:)', '', g, flags=re.IGNORECASE)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
599 return g
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
600
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
601 def _simplify_boolean_expression(expr: str) -> str:
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
602 """
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
603 Simplify a boolean expression by removing duplicates while strictly preserving semantics.
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
604 This function handles simple duplicates within parentheses while being conservative about
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
605 complex expressions that could change semantics.
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
606 """
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
607 if not expr or not expr.strip():
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
608 return expr
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
609
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
610 # Normalize operators and whitespace
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
611 expr = expr.replace(' AND ', ' and ').replace(' OR ', ' or ')
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
612 expr = ' '.join(expr.split()) # Normalize whitespace
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
613
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
614 def simplify_parentheses_content(match_obj):
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
615 """Helper function to simplify content within parentheses."""
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
616 content = match_obj.group(1) # Content inside parentheses
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
617
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
618 # Only simplify if it's a pure OR or pure AND chain
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
619 if ' or ' in content and ' and ' not in content:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
620 # Pure OR chain - safe to deduplicate
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
621 parts = [p.strip() for p in content.split(' or ') if p.strip()]
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
622 unique_parts = []
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
623 seen = set()
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
624 for part in parts:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
625 if part not in seen:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
626 unique_parts.append(part)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
627 seen.add(part)
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
628
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
629 if len(unique_parts) == 1:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
630 return unique_parts[0] # Remove unnecessary parentheses for single items
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
631 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
632 return '(' + ' or '.join(unique_parts) + ')'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
633
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
634 elif ' and ' in content and ' or ' not in content:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
635 # Pure AND chain - safe to deduplicate
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
636 parts = [p.strip() for p in content.split(' and ') if p.strip()]
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
637 unique_parts = []
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
638 seen = set()
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
639 for part in parts:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
640 if part not in seen:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
641 unique_parts.append(part)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
642 seen.add(part)
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
643
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
644 if len(unique_parts) == 1:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
645 return unique_parts[0] # Remove unnecessary parentheses for single items
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
646 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
647 return '(' + ' and '.join(unique_parts) + ')'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
648 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
649 # Mixed operators or single item - return with parentheses as-is
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
650 return '(' + content + ')'
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
651
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
652 def remove_duplicates_simple(parts_str: str, separator: str) -> str:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
653 """Remove duplicates from a simple chain of operations."""
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
654 parts = [p.strip() for p in parts_str.split(separator) if p.strip()]
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
655
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
656 # Remove duplicates while preserving order
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
657 unique_parts = []
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
658 seen = set()
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
659 for part in parts:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
660 if part not in seen:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
661 unique_parts.append(part)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
662 seen.add(part)
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
663
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
664 if len(unique_parts) == 1:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
665 return unique_parts[0]
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
666 else:
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
667 return f' {separator} '.join(unique_parts)
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
668
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
669 try:
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
670 import re
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
671
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
672 # First, simplify content within parentheses
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
673 # This handles cases like (A or A) -> A and (B and B) -> B
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
674 expr_simplified = re.sub(r'\(([^()]+)\)', simplify_parentheses_content, expr)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
675
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
676 # Check if the resulting expression has mixed operators
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
677 has_and = ' and ' in expr_simplified
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
678 has_or = ' or ' in expr_simplified
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
679
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
680 # Only simplify top-level if it's pure AND or pure OR
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
681 if has_and and not has_or and '(' not in expr_simplified:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
682 # Pure AND chain at top level - safe to deduplicate
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
683 return remove_duplicates_simple(expr_simplified, 'and')
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
684 elif has_or and not has_and and '(' not in expr_simplified:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
685 # Pure OR chain at top level - safe to deduplicate
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
686 return remove_duplicates_simple(expr_simplified, 'or')
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
687 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
688 # Mixed operators or has parentheses - return the simplified version (with parentheses content cleaned)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
689 return expr_simplified
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
690
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
691 except Exception:
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
692 # If anything goes wrong, return the original expression
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
693 return expr
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
694
492
4ed95023af20 Uploaded
francesco_lapi
parents: 490
diff changeset
695
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
696 def translate_model_genes(model: 'cobra.Model',
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
697 mapping_df: 'pd.DataFrame',
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
698 target_nomenclature: str,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
699 source_nomenclature: str = 'hgnc_id',
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
700 allow_many_to_one: bool = False,
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
701 logger: Optional[logging.Logger] = None) -> Tuple['cobra.Model', Dict[str, str]]:
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
702 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
703 Translate model genes from source_nomenclature to target_nomenclature using a mapping table.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
704 mapping_df should contain columns enabling mapping (e.g., ensg, hgnc_id, hgnc_symbol, entrez).
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
705
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
706 Args:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
707 model: COBRA model to translate.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
708 mapping_df: DataFrame containing the mapping information.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
709 target_nomenclature: Desired target key (e.g., 'hgnc_symbol').
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
710 source_nomenclature: Current source key in the model (default 'hgnc_id').
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
711 allow_many_to_one: If True, allow many-to-one mappings and handle duplicates in GPRs.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 455
diff changeset
712 logger: Optional logger.
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
713
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
714 Returns:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
715 Tuple containing:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
716 - Translated COBRA model
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
717 - Dictionary mapping reaction IDs to translation issue descriptions
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
718 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
719 if logger is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
720 logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
721 logger = logging.getLogger(__name__)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
722
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
723 logger.info(f"Translating genes from '{source_nomenclature}' to '{target_nomenclature}'")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
724
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
725 # normalize column names and choose relevant columns
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
726 chosen = _choose_columns(mapping_df)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
727 if not chosen:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
728 raise ValueError("Could not detect useful columns in mapping_df. Expected at least one of: ensg, hgnc_id, hgnc_symbol, entrez.")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
729
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
730 # map source/target to actual dataframe column names (allow user-specified source/target keys)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
731 # normalize input args
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
732 src_key = source_nomenclature.strip().lower()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
733 tgt_key = target_nomenclature.strip().lower()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
734
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
735 # try to find the actual column names for requested keys
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
736 col_for_src = None
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
737 col_for_tgt = None
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
738 # first, try exact match
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
739 for k, actual in chosen.items():
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
740 if k == src_key:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
741 col_for_src = actual
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
742 if k == tgt_key:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
743 col_for_tgt = actual
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
744
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
745 # if not found, try mapping common names
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
746 if col_for_src is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
747 possible_src_names = {k: v for k, v in chosen.items()}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
748 # try to match by contained substring
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
749 for k, actual in possible_src_names.items():
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
750 if src_key in k:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
751 col_for_src = actual
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
752 break
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
753
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
754 if col_for_tgt is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
755 for k, actual in chosen.items():
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
756 if tgt_key in k:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
757 col_for_tgt = actual
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
758 break
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
759
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
760 if col_for_src is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
761 raise ValueError(f"Source column for '{source_nomenclature}' not found in mapping dataframe.")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
762 if col_for_tgt is None:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
763 raise ValueError(f"Target column for '{target_nomenclature}' not found in mapping dataframe.")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
764
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
765 model_source_genes = { _normalize_gene_id(g.id) for g in model.genes }
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
766 logger.info(f"Filtering mapping to {len(model_source_genes)} source genes present in model (normalized).")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
767
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
768 tmp_map = mapping_df[[col_for_src, col_for_tgt]].dropna().copy()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
769 tmp_map[col_for_src + "_norm"] = tmp_map[col_for_src].astype(str).map(_normalize_gene_id)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
770
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
771 filtered_map = tmp_map[tmp_map[col_for_src + "_norm"].isin(model_source_genes)].copy()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
772
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
773 if filtered_map.empty:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
774 logger.warning("No mapping rows correspond to source genes present in the model after filtering. Proceeding with empty mapping (no translation will occur).")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
775
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
776 if not allow_many_to_one:
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
777 _validate_target_uniqueness(filtered_map, col_for_src, col_for_tgt, model_source_genes=model_source_genes, logger=logger)
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
778
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
779 # Crea il mapping
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
780 gene_mapping = _create_gene_mapping(filtered_map, col_for_src, col_for_tgt, logger)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
781
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
782 # copy model
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
783 model_copy = model.copy()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
784
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
785 # statistics
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
786 stats = {'translated': 0, 'one_to_one': 0, 'one_to_many': 0, 'not_found': 0, 'simplified_gprs': 0}
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
787 unmapped = []
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
788 multi = []
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
789
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
790 # Dictionary to store translation issues per reaction
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
791 reaction_translation_issues = {}
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
792
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
793 original_genes = {g.id for g in model_copy.genes}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
794 logger.info(f"Original genes count: {len(original_genes)}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
795
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
796 # translate GPRs
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
797 for rxn in model_copy.reactions:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
798 gpr = rxn.gene_reaction_rule
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
799 if gpr and gpr.strip():
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
800 new_gpr, rxn_issues = _translate_gpr(gpr, gene_mapping, stats, unmapped, multi, logger, track_issues=True)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
801 if rxn_issues:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
802 reaction_translation_issues[rxn.id] = rxn_issues
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
803
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
804 if new_gpr != gpr:
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
805 simplified_gpr = _simplify_boolean_expression(new_gpr)
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
806 if simplified_gpr != new_gpr:
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
807 stats['simplified_gprs'] += 1
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
808 logger.debug(f"Simplified GPR for {rxn.id}: '{new_gpr}' -> '{simplified_gpr}'")
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
809 rxn.gene_reaction_rule = simplified_gpr
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
810 logger.debug(f"Reaction {rxn.id}: '{gpr}' -> '{simplified_gpr}'")
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
811
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
812 # update model genes based on new GPRs
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
813 _update_model_genes(model_copy, logger)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
814
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
815 # final logging
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
816 _log_translation_statistics(stats, unmapped, multi, original_genes, model_copy.genes, logger)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
817
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
818 logger.info("Translation finished")
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
819 return model_copy, reaction_translation_issues
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
820
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
821
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
822 # ---------- helper functions ----------
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
823 def _create_gene_mapping(mapping_df, source_col: str, target_col: str, logger: logging.Logger) -> Dict[str, List[str]]:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
824 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
825 Build mapping dict: source_id -> list of target_ids
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
826 Normalizes IDs (removes prefixes like 'HGNC:' etc).
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
827 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
828 df = mapping_df[[source_col, target_col]].dropna().copy()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
829 # normalize to string
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
830 df[source_col] = df[source_col].astype(str).map(_normalize_gene_id)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
831 df[target_col] = df[target_col].astype(str).str.strip()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
832
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
833 df = df.drop_duplicates()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
834
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
835 logger.info(f"Creating mapping from {len(df)} rows")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
836
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
837 mapping = defaultdict(list)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
838 for _, row in df.iterrows():
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
839 s = row[source_col]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
840 t = row[target_col]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
841 if t not in mapping[s]:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
842 mapping[s].append(t)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
843
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
844 # stats
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
845 one_to_one = sum(1 for v in mapping.values() if len(v) == 1)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
846 one_to_many = sum(1 for v in mapping.values() if len(v) > 1)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
847 logger.info(f"Mapping: {len(mapping)} source keys, {one_to_one} 1:1, {one_to_many} 1:many")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
848 return dict(mapping)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
849
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
850
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
851 def _translate_gpr(gpr_string: str,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
852 gene_mapping: Dict[str, List[str]],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
853 stats: Dict[str, int],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
854 unmapped_genes: List[str],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
855 multi_mapping_genes: List[Tuple[str, List[str]]],
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
856 logger: logging.Logger,
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
857 track_issues: bool = False) -> Union[str, Tuple[str, str]]:
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
858 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
859 Translate genes inside a GPR string using gene_mapping.
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
860 Returns new GPR string, and optionally translation issues if track_issues=True.
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
861 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
862 # Generic token pattern: letters, digits, :, _, -, ., (captures HGNC:1234, ENSG000..., symbols)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
863 token_pattern = r'\b[A-Za-z0-9:_.-]+\b'
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
864 tokens = re.findall(token_pattern, gpr_string)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
865
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
866 logical = {'and', 'or', 'AND', 'OR', '(', ')'}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
867 tokens = [t for t in tokens if t not in logical]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
868
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
869 new_gpr = gpr_string
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
870 issues = []
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
871
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
872 for token in sorted(set(tokens), key=lambda x: -len(x)): # longer tokens first to avoid partial replacement
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
873 norm = _normalize_gene_id(token)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
874 if norm in gene_mapping:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
875 targets = gene_mapping[norm]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
876 stats['translated'] += 1
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
877 if len(targets) == 1:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
878 stats['one_to_one'] += 1
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
879 replacement = targets[0]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
880 else:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
881 stats['one_to_many'] += 1
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
882 multi_mapping_genes.append((token, targets))
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
883 replacement = "(" + " or ".join(targets) + ")"
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
884 if track_issues:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
885 issues.append(f"{token} -> {' or '.join(targets)}")
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
886
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
887 pattern = r'\b' + re.escape(token) + r'\b'
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
888 new_gpr = re.sub(pattern, replacement, new_gpr)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
889 else:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
890 stats['not_found'] += 1
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
891 if token not in unmapped_genes:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
892 unmapped_genes.append(token)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
893 logger.debug(f"Token not found in mapping (left as-is): {token}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
894
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
895 # Check for many-to-one cases (multiple source genes mapping to same target)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
896 if track_issues:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
897 # Build reverse mapping to detect many-to-one cases from original tokens
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
898 original_to_target = {}
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
899
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
900 for orig_token in tokens:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
901 norm = _normalize_gene_id(orig_token)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
902 if norm in gene_mapping:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
903 targets = gene_mapping[norm]
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
904 for target in targets:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
905 if target not in original_to_target:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
906 original_to_target[target] = []
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
907 if orig_token not in original_to_target[target]:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
908 original_to_target[target].append(orig_token)
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
909
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
910 # Identify many-to-one mappings in this specific GPR
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
911 for target, original_genes in original_to_target.items():
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
912 if len(original_genes) > 1:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
913 issues.append(f"{' or '.join(original_genes)} -> {target}")
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
914
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
915 issue_text = "; ".join(issues) if issues else ""
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
916
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
917 if track_issues:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
918 return new_gpr, issue_text
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
919 else:
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
920 return new_gpr
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
921
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
922
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
923 def _update_model_genes(model: 'cobra.Model', logger: logging.Logger):
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
924 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
925 Rebuild model.genes from gene_reaction_rule content.
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
926 Removes genes not referenced and adds missing ones.
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
927 """
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
928 # collect genes in GPRs
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
929 gene_pattern = r'\b[A-Za-z0-9:_.-]+\b'
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
930 logical = {'and', 'or', 'AND', 'OR', '(', ')'}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
931 genes_in_gpr: Set[str] = set()
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
932
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
933 for rxn in model.reactions:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
934 gpr = rxn.gene_reaction_rule
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
935 if gpr and gpr.strip():
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
936 toks = re.findall(gene_pattern, gpr)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
937 toks = [t for t in toks if t not in logical]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
938 # normalize IDs consistent with mapping normalization
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
939 toks = [_normalize_gene_id(t) for t in toks]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
940 genes_in_gpr.update(toks)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
941
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
942 # existing gene ids
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
943 existing = {g.id for g in model.genes}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
944
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
945 # remove obsolete genes
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
946 to_remove = [gid for gid in existing if gid not in genes_in_gpr]
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
947 removed = 0
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
948 for gid in to_remove:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
949 try:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
950 gene_obj = model.genes.get_by_id(gid)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
951 model.genes.remove(gene_obj)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
952 removed += 1
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
953 except Exception:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
954 # safe-ignore
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
955 pass
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
956
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
957 # add new genes
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
958 added = 0
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
959 for gid in genes_in_gpr:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
960 if gid not in existing:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
961 new_gene = cobra.Gene(gid)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
962 try:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
963 model.genes.add(new_gene)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
964 except Exception:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
965 # fallback: if model.genes doesn't support add, try append or model.add_genes
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
966 try:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
967 model.genes.append(new_gene)
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
968 except Exception:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
969 try:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
970 model.add_genes([new_gene])
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
971 except Exception:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
972 logger.warning(f"Could not add gene object for {gid}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
973 added += 1
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
974
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
975 logger.info(f"Model genes updated: removed {removed}, added {added}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
976
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
977
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
978 def _log_translation_statistics(stats: Dict[str, int],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
979 unmapped_genes: List[str],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
980 multi_mapping_genes: List[Tuple[str, List[str]]],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
981 original_genes: Set[str],
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
982 final_genes,
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
983 logger: logging.Logger):
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
984 logger.info("=== TRANSLATION STATISTICS ===")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
985 logger.info(f"Translated: {stats.get('translated', 0)} (1:1 = {stats.get('one_to_one', 0)}, 1:many = {stats.get('one_to_many', 0)})")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
986 logger.info(f"Not found tokens: {stats.get('not_found', 0)}")
455
4e2bc80764b6 Uploaded
francesco_lapi
parents: 448
diff changeset
987 logger.info(f"Simplified GPRs: {stats.get('simplified_gprs', 0)}")
426
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
988
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
989 final_ids = {g.id for g in final_genes}
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
990 logger.info(f"Genes in model: {len(original_genes)} -> {len(final_ids)}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
991
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
992 if unmapped_genes:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
993 logger.warning(f"Unmapped tokens ({len(unmapped_genes)}): {', '.join(unmapped_genes[:20])}{(' ...' if len(unmapped_genes)>20 else '')}")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
994 if multi_mapping_genes:
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
995 logger.info(f"Multi-mapping examples ({len(multi_mapping_genes)}):")
00a78da611ba Uploaded
francesco_lapi
parents: 419
diff changeset
996 for orig, targets in multi_mapping_genes[:10]:
490
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
997 logger.info(f" {orig} -> {', '.join(targets)}")
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
998
c6ea189ea7e9 Uploaded
francesco_lapi
parents: 456
diff changeset
999