Mercurial > repos > bimib > cobraxy

comparison COBRAxy/ras_to_bounds.py @ 86:f17137e8824a draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author luca_milaz
date Sun, 13 Oct 2024 11:31:52 +0000
parents
children
comparison
equal deleted inserted replaced
85:7ffe9d0477cf 86:f17137e8824a
1 import argparse
2 import utils.general_utils as utils
3 from typing import Optional, List
4 import os
5 import numpy as np
6 import pandas as pd
7 import cobra
8 import sys
9 import csv
10 from joblib import Parallel, delayed, cpu_count
11
12 ################################# process args ###############################
13 def process_args(args :List[str]) -> argparse.Namespace:
14 """
15 Processes command-line arguments.
16
17 Args:
18 args (list): List of command-line arguments.
19
20 Returns:
21 Namespace: An object containing parsed arguments.
22 """
23 parser = argparse.ArgumentParser(usage = '%(prog)s [options]',
24 description = 'process some value\'s')
25
26 parser.add_argument(
27 '-ms', '--model_selector',
28 type = utils.Model, default = utils.Model.ENGRO2, choices = [utils.Model.ENGRO2, utils.Model.Custom],
29 help = 'chose which type of model you want use')
30
31 parser.add_argument("-mo", "--model", type = str,
32 help = "path to input file with custom rules, if provided")
33
34 parser.add_argument("-mn", "--model_name", type = str, help = "custom mode name")
35
36 parser.add_argument(
37 '-mes', '--medium_selector',
38 default = "allOpen",
39 help = 'chose which type of medium you want use')
40
41 parser.add_argument("-meo", "--medium", type = str,
42 help = "path to input file with custom medium, if provided")
43
44 parser.add_argument('-ol', '--out_log',
45 help = "Output log")
46
47 parser.add_argument('-td', '--tool_dir',
48 type = str,
49 required = True,
50 help = 'your tool directory')
51
52 parser.add_argument('-ir', '--input_ras',
53 type=str,
54 required = False,
55 help = 'input ras')
56
57 parser.add_argument('-rn', '--names',
58 type=str,
59 help = 'ras class names')
60
61 parser.add_argument('-rs', '--ras_selector',
62 required = True,
63 type=utils.Bool("using_RAS"),
64 help = 'ras selector')
65
66 parser.add_argument('-cc', '--cell_class',
67 type = str,
68 help = 'output of cell class')
69
70
71 ARGS = parser.parse_args()
72 return ARGS
73
74 ########################### warning ###########################################
75 def warning(s :str) -> None:
76 """
77 Log a warning message to an output log file and print it to the console.
78
79 Args:
80 s (str): The warning message to be logged and printed.
81
82 Returns:
83 None
84 """
85 with open(ARGS.out_log, 'a') as log:
86 log.write(s + "\n\n")
87 print(s)
88
89 ############################ dataset input ####################################
90 def read_dataset(data :str, name :str) -> pd.DataFrame:
91 """
92 Read a dataset from a CSV file and return it as a pandas DataFrame.
93
94 Args:
95 data (str): Path to the CSV file containing the dataset.
96 name (str): Name of the dataset, used in error messages.
97
98 Returns:
99 pandas.DataFrame: DataFrame containing the dataset.
100
101 Raises:
102 pd.errors.EmptyDataError: If the CSV file is empty.
103 sys.exit: If the CSV file has the wrong format, the execution is aborted.
104 """
105 try:
106 dataset = pd.read_csv(data, sep = '\t', header = 0, engine='python')
107 except pd.errors.EmptyDataError:
108 sys.exit('Execution aborted: wrong format of ' + name + '\n')
109 if len(dataset.columns) < 2:
110 sys.exit('Execution aborted: wrong format of ' + name + '\n')
111 return dataset
112
113
114 def apply_ras_bounds(model, ras_row, rxns_ids):
115 """
116 Adjust the bounds of reactions in the model based on RAS values.
117
118 Args:
119 model (cobra.Model): The metabolic model to be modified.
120 ras_row (pd.Series): A row from a RAS DataFrame containing scaling factors for reaction bounds.
121 rxns_ids (list of str): List of reaction IDs to which the scaling factors will be applied.
122
123 Returns:
124 None
125 """
126 for reaction in rxns_ids:
127 if reaction in ras_row.index:
128 scaling_factor = ras_row[reaction]
129 lower_bound=model.reactions.get_by_id(reaction).lower_bound
130 upper_bound=model.reactions.get_by_id(reaction).upper_bound
131 #warning("Reaction: "+reaction+" Lower Bound: "+str(lower_bound)+" Upper Bound: "+str(upper_bound)+" Scaling Factor: "+str(scaling_factor))
132 valMax=float((upper_bound)*scaling_factor)
133 valMin=float((lower_bound)*scaling_factor)
134 if upper_bound!=0 and lower_bound==0:
135 model.reactions.get_by_id(reaction).upper_bound=valMax
136 if upper_bound==0 and lower_bound!=0:
137 model.reactions.get_by_id(reaction).lower_bound=valMin
138 if upper_bound!=0 and lower_bound!=0:
139 model.reactions.get_by_id(reaction).lower_bound=valMin
140 model.reactions.get_by_id(reaction).upper_bound=valMax
141 pass
142
143 def process_ras_cell(cellName, ras_row, model, rxns_ids, output_folder):
144 """
145 Process a single RAS cell, apply bounds, and save the bounds to a CSV file.
146
147 Args:
148 cellName (str): The name of the RAS cell (used for naming the output file).
149 ras_row (pd.Series): A row from a RAS DataFrame containing scaling factors for reaction bounds.
150 model (cobra.Model): The metabolic model to be modified.
151 rxns_ids (list of str): List of reaction IDs to which the scaling factors will be applied.
152 output_folder (str): Folder path where the output CSV file will be saved.
153
154 Returns:
155 None
156 """
157 model_new = model.copy()
158 apply_ras_bounds(model_new, ras_row, rxns_ids)
159 bounds = pd.DataFrame([(rxn.lower_bound, rxn.upper_bound) for rxn in model_new.reactions], index=rxns_ids, columns=["lower_bound", "upper_bound"])
160 bounds.to_csv(output_folder + cellName + ".csv", sep='\t', index=True)
161 pass
162
163 def generate_bounds(model: cobra.Model, medium: dict, ras=None, output_folder='output/') -> pd.DataFrame:
164 """
165 Generate reaction bounds for a metabolic model based on medium conditions and optional RAS adjustments.
166
167 Args:
168 model (cobra.Model): The metabolic model for which bounds will be generated.
169 medium (dict): A dictionary where keys are reaction IDs and values are the medium conditions.
170 ras (pd.DataFrame, optional): RAS pandas dataframe. Defaults to None.
171 output_folder (str, optional): Folder path where output CSV files will be saved. Defaults to 'output/'.
172
173 Returns:
174 pd.DataFrame: DataFrame containing the bounds of reactions in the model.
175 """
176 rxns_ids = [rxn.id for rxn in model.reactions]
177
178 # Set medium conditions
179 for reaction, value in medium.items():
180 if value is not None:
181 model.reactions.get_by_id(reaction).lower_bound = -float(value)
182
183 # Perform Flux Variability Analysis (FVA)
184 df_FVA = cobra.flux_analysis.flux_variability_analysis(model, fraction_of_optimum=0, processes=1).round(8)
185
186 # Set FVA bounds
187 for reaction in rxns_ids:
188 rxn = model.reactions.get_by_id(reaction)
189 rxn.lower_bound = float(df_FVA.loc[reaction, "minimum"])
190 rxn.upper_bound = float(df_FVA.loc[reaction, "maximum"])
191
192 if ras is not None:
193 Parallel(n_jobs=cpu_count())(delayed(process_ras_cell)(cellName, ras_row, model, rxns_ids, output_folder) for cellName, ras_row in ras.iterrows())
194 #for cellName, ras_row in ras.iterrows():
195 #process_ras_cell(cellName, ras_row, model, rxns_ids, output_folder)
196 else:
197 model_new = model.copy()
198 apply_ras_bounds(model_new, pd.Series([1]*len(rxns_ids), index=rxns_ids), rxns_ids)
199 bounds = pd.DataFrame([(rxn.lower_bound, rxn.upper_bound) for rxn in model_new.reactions], index=rxns_ids, columns=["lower_bound", "upper_bound"])
200 bounds.to_csv(output_folder + "bounds.csv", sep='\t', index=True)
201 pass
202
203
204
205 ############################# main ###########################################
206 def main() -> None:
207 """
208 Initializes everything and sets the program in motion based on the fronted input arguments.
209
210 Returns:
211 None
212 """
213 if not os.path.exists('ras_to_bounds'):
214 os.makedirs('ras_to_bounds')
215
216
217 global ARGS
218 ARGS = process_args(sys.argv)
219
220 ARGS.output_folder = 'ras_to_bounds/'
221
222 if(ARGS.ras_selector == True):
223 ras_file_list = ARGS.input_ras.split(",")
224 ras_file_names = ARGS.names.split(",")
225 ras_class_names = []
226 for file in ras_file_names:
227 ras_class_names.append(file.split(".")[0])
228 ras_list = []
229 class_assignments = pd.DataFrame(columns=["Patient_ID", "Class"])
230 for ras_matrix, ras_class_name in zip(ras_file_list, ras_class_names):
231 ras = read_dataset(ras_matrix, "ras dataset")
232 ras.replace("None", None, inplace=True)
233 ras.set_index("Reactions", drop=True, inplace=True)
234 ras = ras.T
235 ras = ras.astype(float)
236 ras_list.append(ras)
237 for patient_id in ras.index:
238 class_assignments.loc[class_assignments.shape[0]] = [patient_id, ras_class_name]
239
240
241 # Concatenate all ras DataFrames into a single DataFrame
242 ras_combined = pd.concat(ras_list, axis=0)
243 # Normalize the RAS values by max RAS
244 ras_combined = ras_combined.div(ras_combined.max(axis=0))
245 ras_combined = ras_combined.fillna(0)
246
247
248
249 model_type :utils.Model = ARGS.model_selector
250 if model_type is utils.Model.Custom:
251 model = model_type.getCOBRAmodel(customPath = utils.FilePath.fromStrPath(ARGS.model), customExtension = utils.FilePath.fromStrPath(ARGS.model_name).ext)
252 else:
253 model = model_type.getCOBRAmodel(toolDir=ARGS.tool_dir)
254
255 if(ARGS.medium_selector == "Custom"):
256 medium = read_dataset(ARGS.medium, "medium dataset")
257 medium.set_index(medium.columns[0], inplace=True)
258 medium = medium.astype(float)
259 medium = medium[medium.columns[0]].to_dict()
260 else:
261 df_mediums = pd.read_csv(ARGS.tool_dir + "/local/medium/medium.csv", index_col = 0)
262 ARGS.medium_selector = ARGS.medium_selector.replace("_", " ")
263 medium = df_mediums[[ARGS.medium_selector]]
264 medium = medium[ARGS.medium_selector].to_dict()
265
266 if(ARGS.ras_selector == True):
267 generate_bounds(model, medium, ras = ras_combined, output_folder=ARGS.output_folder)
268 class_assignments.to_csv(ARGS.cell_class, sep = '\t', index = False)
269 else:
270 generate_bounds(model, medium, output_folder=ARGS.output_folder)
271
272 pass
273
274 ##############################################################################
275 if __name__ == "__main__":
276 main()