annotate COBRAxy/marea.py @ 130:03bbbd9af67d draft

Uploaded
author luca_milaz
date Tue, 15 Oct 2024 18:31:34 +0000
parents 41f35c2f0c7b
children 507efdc9d226
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
1 from __future__ import division
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
2 import csv
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
3 from enum import Enum
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
4 import re
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
5 import sys
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
6 import numpy as np
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
7 import pandas as pd
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
8 import itertools as it
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
9 import scipy.stats as st
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
10 import lxml.etree as ET
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
11 import math
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
12 import utils.general_utils as utils
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
13 from PIL import Image
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
14 import os
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
15 import argparse
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
16 import pyvips
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
17 from typing import Tuple, Union, Optional, List, Dict
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
18
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
19 ERRORS = []
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
20 ########################## argparse ##########################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
21 ARGS :argparse.Namespace
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
22 def process_args() -> argparse.Namespace:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
23 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
24 Interfaces the script of a module with its frontend, making the user's choices for various parameters available as values in code.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
25
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
26 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
27 args : Always obtained (in file) from sys.argv
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
28
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
29 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
30 Namespace : An object containing the parsed arguments
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
31 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
32 parser = argparse.ArgumentParser(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
33 usage = "%(prog)s [options]",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
34 description = "process some value's genes to create a comparison's map.")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
35
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
36 #General:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
37 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
38 '-td', '--tool_dir',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
39 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
40 required = True,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
41 help = 'your tool directory')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
42
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
43 parser.add_argument('-on', '--control', type = str)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
44 parser.add_argument('-ol', '--out_log', help = "Output log")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
45
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
46 #Computation details:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
47 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
48 '-co', '--comparison',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
49 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
50 default = '1vs1',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
51 choices = ['manyvsmany', 'onevsrest', 'onevsmany'])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
52
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
53 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
54 '-pv' ,'--pValue',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
55 type = float,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
56 default = 0.1,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
57 help = 'P-Value threshold (default: %(default)s)')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
58
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
59 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
60 '-fc', '--fChange',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
61 type = float,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
62 default = 1.5,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
63 help = 'Fold-Change threshold (default: %(default)s)')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
64
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
65 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
66 "-ne", "--net",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
67 type = utils.Bool("net"), default = False,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
68 help = "choose if you want net enrichment for RPS")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
69
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
70 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
71 '-op', '--option',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
72 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
73 choices = ['datasets', 'dataset_class'],
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
74 help='dataset or dataset and class')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
75
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
76 #RAS:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
77 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
78 "-ra", "--using_RAS",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
79 type = utils.Bool("using_RAS"), default = True,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
80 help = "choose whether to use RAS datasets.")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
81
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
82 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
83 '-id', '--input_data',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
84 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
85 help = 'input dataset')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
86
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
87 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
88 '-ic', '--input_class',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
89 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
90 help = 'sample group specification')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
91
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
92 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
93 '-ids', '--input_datas',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
94 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
95 nargs = '+',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
96 help = 'input datasets')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
97
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
98 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
99 '-na', '--names',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
100 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
101 nargs = '+',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
102 help = 'input names')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
103
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
104 #RPS:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
105 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
106 "-rp", "--using_RPS",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
107 type = utils.Bool("using_RPS"), default = False,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
108 help = "choose whether to use RPS datasets.")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
109
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
110 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
111 '-idr', '--input_data_rps',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
112 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
113 help = 'input dataset rps')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
114
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
115 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
116 '-icr', '--input_class_rps',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
117 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
118 help = 'sample group specification rps')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
119
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
120 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
121 '-idsr', '--input_datas_rps',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
122 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
123 nargs = '+',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
124 help = 'input datasets rps')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
125
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
126 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
127 '-nar', '--names_rps',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
128 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
129 nargs = '+',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
130 help = 'input names rps')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
131
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
132 #Output:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
133 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
134 "-gs", "--generate_svg",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
135 type = utils.Bool("generate_svg"), default = True,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
136 help = "choose whether to use RAS datasets.")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
137
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
138 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
139 "-gp", "--generate_pdf",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
140 type = utils.Bool("generate_pdf"), default = True,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
141 help = "choose whether to use RAS datasets.")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
142
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
143 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
144 '-cm', '--custom_map',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
145 type = str,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
146 help='custom map to use')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
147
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
148 parser.add_argument(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
149 '-mc', '--choice_map',
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
150 type = utils.Model, default = utils.Model.HMRcore,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
151 choices = [utils.Model.HMRcore, utils.Model.ENGRO2, utils.Model.Custom])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
152
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
153 args :argparse.Namespace = parser.parse_args()
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
154 if args.using_RAS and not args.using_RPS: args.net = False
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
155
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
156 return args
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
157
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
158 ############################ dataset input ####################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
159 def read_dataset(data :str, name :str) -> pd.DataFrame:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
160 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
161 Tries to read the dataset from its path (data) as a tsv and turns it into a DataFrame.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
162
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
163 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
164 data : filepath of a dataset (from frontend input params or literals upon calling)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
165 name : name associated with the dataset (from frontend input params or literals upon calling)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
166
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
167 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
168 pd.DataFrame : dataset in a runtime operable shape
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
169
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
170 Raises:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
171 sys.exit : if there's no data (pd.errors.EmptyDataError) or if the dataset has less than 2 columns
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
172 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
173 try:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
174 dataset = pd.read_csv(data, sep = '\t', header = 0, engine='python')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
175 except pd.errors.EmptyDataError:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
176 sys.exit('Execution aborted: wrong format of ' + name + '\n')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
177 if len(dataset.columns) < 2:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
178 sys.exit('Execution aborted: wrong format of ' + name + '\n')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
179 return dataset
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
180
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
181 ############################ dataset name #####################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
182 def name_dataset(name_data :str, count :int) -> str:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
183 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
184 Produces a unique name for a dataset based on what was provided by the user. The default name for any dataset is "Dataset", thus if the user didn't change it this function appends f"_{count}" to make it unique.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
185
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
186 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
187 name_data : name associated with the dataset (from frontend input params)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
188 count : counter from 1 to make these names unique (external)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
189
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
190 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
191 str : the name made unique
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
192 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
193 if str(name_data) == 'Dataset':
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
194 return str(name_data) + '_' + str(count)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
195 else:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
196 return str(name_data)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
197
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
198 ############################ map_methods ######################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
199 FoldChange = Union[float, int, str] # Union[float, Literal[0, "-INF", "INF"]]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
200 def fold_change(avg1 :float, avg2 :float) -> FoldChange:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
201 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
202 Calculates the fold change between two gene expression values.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
203
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
204 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
205 avg1 : average expression value from one dataset avg2 : average expression value from the other dataset
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
206
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
207 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
208 FoldChange :
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
209 0 : when both input values are 0
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
210 "-INF" : when avg1 is 0
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
211 "INF" : when avg2 is 0
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
212 float : for any other combination of values
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
213 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
214 if avg1 == 0 and avg2 == 0:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
215 return 0
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
216 elif avg1 == 0:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
217 return '-INF'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
218 elif avg2 == 0:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
219 return 'INF'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
220 else: # (threshold_F_C - 1) / (abs(threshold_F_C) + 1) con threshold_F_C > 1
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
221 return (avg1 - avg2) / (abs(avg1) + abs(avg2))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
222
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
223 def fix_style(l :str, col :Optional[str], width :str, dash :str) -> str:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
224 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
225 Produces a "fixed" style string to assign to a reaction arrow in the SVG map, assigning style properties to the corresponding values passed as input params.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
226
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
227 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
228 l : current style string of an SVG element
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
229 col : new value for the "stroke" style property
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
230 width : new value for the "stroke-width" style property
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
231 dash : new value for the "stroke-dasharray" style property
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
232
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
233 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
234 str : the fixed style string
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
235 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
236 tmp = l.split(';')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
237 flag_col = False
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
238 flag_width = False
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
239 flag_dash = False
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
240 for i in range(len(tmp)):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
241 if tmp[i].startswith('stroke:'):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
242 tmp[i] = 'stroke:' + col
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
243 flag_col = True
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
244 if tmp[i].startswith('stroke-width:'):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
245 tmp[i] = 'stroke-width:' + width
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
246 flag_width = True
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
247 if tmp[i].startswith('stroke-dasharray:'):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
248 tmp[i] = 'stroke-dasharray:' + dash
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
249 flag_dash = True
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
250 if not flag_col:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
251 tmp.append('stroke:' + col)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
252 if not flag_width:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
253 tmp.append('stroke-width:' + width)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
254 if not flag_dash:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
255 tmp.append('stroke-dasharray:' + dash)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
256 return ';'.join(tmp)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
257
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
258 # The type of d values is collapsed, losing precision, because the dict containst lists instead of tuples, please fix!
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
259 def fix_map(d :Dict[str, List[Union[float, FoldChange]]], core_map :ET.ElementTree, threshold_P_V :float, threshold_F_C :float, max_z_score :float) -> ET.ElementTree:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
260 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
261 Edits the selected SVG map based on the p-value and fold change data (d) and some significance thresholds also passed as inputs.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
262
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
263 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
264 d : dictionary mapping a p-value and a fold-change value (values) to each reaction ID as encoded in the SVG map (keys)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
265 core_map : SVG map to modify
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
266 threshold_P_V : threshold for a p-value to be considered significant
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
267 threshold_F_C : threshold for a fold change value to be considered significant
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
268 max_z_score : highest z-score (absolute value)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
269
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
270 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
271 ET.ElementTree : the modified core_map
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
272
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
273 Side effects:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
274 core_map : mut
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
275 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
276 maxT = 12
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
277 minT = 2
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
278 grey = '#BEBEBE'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
279 blue = '#6495ed'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
280 red = '#ecac68'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
281 for el in core_map.iter():
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
282 el_id = str(el.get('id'))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
283 if el_id.startswith('R_'):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
284 tmp = d.get(el_id[2:])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
285 if tmp != None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
286 p_val :float = tmp[0]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
287 f_c = tmp[1]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
288 z_score = tmp[2]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
289 if p_val < threshold_P_V:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
290 if not isinstance(f_c, str):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
291 if abs(f_c) < ((threshold_F_C - 1) / (abs(threshold_F_C) + 1)): #
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
292 col = grey
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
293 width = str(minT)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
294 else:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
295 if f_c < 0:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
296 col = blue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
297 elif f_c > 0:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
298 col = red
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
299 width = str(max((abs(z_score) * maxT) / max_z_score, minT))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
300 else:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
301 if f_c == '-INF':
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
302 col = blue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
303 elif f_c == 'INF':
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
304 col = red
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
305 width = str(maxT)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
306 dash = 'none'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
307 else:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
308 dash = '5,5'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
309 col = grey
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
310 width = str(minT)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
311 el.set('style', fix_style(el.get('style', ""), col, width, dash))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
312 return core_map
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
313
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
314 def getElementById(reactionId :str, metabMap :ET.ElementTree) -> utils.Result[ET.Element, utils.Result.ResultErr]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
315 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
316 Finds any element in the given map with the given ID. ID uniqueness in an svg file is recommended but
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
317 not enforced, if more than one element with the exact ID is found only the first will be returned.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
318
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
319 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
320 reactionId (str): exact ID of the requested element.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
321 metabMap (ET.ElementTree): metabolic map containing the element.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
322
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
323 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
324 utils.Result[ET.Element, ResultErr]: result of the search, either the first match found or a ResultErr.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
325 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
326 return utils.Result.Ok(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
327 f"//*[@id=\"{reactionId}\"]").map(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
328 lambda xPath : metabMap.xpath(xPath)[0]).mapErr(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
329 lambda _ : utils.Result.ResultErr(f"No elements with ID \"{reactionId}\" found in map"))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
330 # ^^^ we shamelessly ignore the contents of the IndexError, it offers nothing to the user.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
331
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
332 def styleMapElement(element :ET.Element, styleStr :str) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
333 currentStyles :str = element.get("style", "")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
334 if re.search(r";stroke:[^;]+;stroke-width:[^;]+;stroke-dasharray:[^;]+$", currentStyles):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
335 currentStyles = ';'.join(currentStyles.split(';')[:-3])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
336
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
337 element.set("style", currentStyles + styleStr)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
338
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
339 class ReactionDirection(Enum):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
340 Unknown = ""
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
341 Direct = "_F"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
342 Inverse = "_B"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
343
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
344 @classmethod
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
345 def fromDir(cls, s :str) -> "ReactionDirection":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
346 # vvv as long as there's so few variants I actually condone the if spam:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
347 if s == ReactionDirection.Direct.value: return ReactionDirection.Direct
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
348 if s == ReactionDirection.Inverse.value: return ReactionDirection.Inverse
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
349 return ReactionDirection.Unknown
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
350
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
351 @classmethod
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
352 def fromReactionId(cls, reactionId :str) -> "ReactionDirection":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
353 return ReactionDirection.fromDir(reactionId[-2:])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
354
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
355 def getArrowBodyElementId(reactionId :str) -> str:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
356 if reactionId.endswith("_RV"): reactionId = reactionId[:-3] #TODO: standardize _RV
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
357 elif ReactionDirection.fromReactionId(reactionId) is not ReactionDirection.Unknown: reactionId = reactionId[:-2]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
358 return f"R_{reactionId}"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
359
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
360 def getArrowHeadElementId(reactionId :str) -> Tuple[str, str]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
361 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
362 We attempt extracting the direction information from the provided reaction ID, if unsuccessful we provide the IDs of both directions.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
363
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
364 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
365 reactionId : the provided reaction ID.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
366
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
367 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
368 Tuple[str, str]: either a single str ID for the correct arrow head followed by an empty string or both options to try.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
369 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
370 if reactionId.endswith("_RV"): reactionId = reactionId[:-3] #TODO: standardize _RV
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
371 elif ReactionDirection.fromReactionId(reactionId) is not ReactionDirection.Unknown: return reactionId[:-3:-1] + reactionId[:-2], ""
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
372 return f"F_{reactionId}", f"B_{reactionId}"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
373
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
374 class ArrowColor(Enum):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
375 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
376 Encodes possible arrow colors based on their meaning in the enrichment process.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
377 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
378 Invalid = "#BEBEBE" # gray, fold-change under treshold
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
379 UpRegulated = "#ecac68" # red, up-regulated reaction
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
380 DownRegulated = "#6495ed" # blue, down-regulated reaction
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
381
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
382 UpRegulatedInv = "#FF0000"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
383 # ^^^ different shade of red (actually orange), up-regulated net value for a reversible reaction with
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
384 # conflicting enrichment in the two directions.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
385
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
386 DownRegulatedInv = "#0000FF"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
387 # ^^^ different shade of blue (actually purple), down-regulated net value for a reversible reaction with
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
388 # conflicting enrichment in the two directions.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
389
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
390 @classmethod
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
391 def fromFoldChangeSign(cls, foldChange :float, *, useAltColor = False) -> "ArrowColor":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
392 colors = (cls.DownRegulated, cls.DownRegulatedInv) if foldChange < 0 else (cls.UpRegulated, cls.UpRegulatedInv)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
393 return colors[useAltColor]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
394
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
395 def __str__(self) -> str: return self.value
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
396
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
397 class Arrow:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
398 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
399 Models the properties of a reaction arrow that change based on enrichment.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
400 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
401 MIN_W = 2
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
402 MAX_W = 12
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
403
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
404 def __init__(self, width :int, col: ArrowColor, *, isDashed = False) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
405 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
406 (Private) Initializes an instance of Arrow.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
407
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
408 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
409 width : width of the arrow, ideally to be kept within Arrow.MIN_W and Arrow.MAX_W (not enforced).
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
410 col : color of the arrow.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
411 isDashed : whether the arrow should be dashed, meaning the associated pValue resulted not significant.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
412
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
413 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
414 None : practically, a Arrow instance.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
415 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
416 self.w = width
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
417 self.col = col
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
418 self.dash = isDashed
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
419
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
420 def applyTo(self, reactionId :str, metabMap :ET.ElementTree, styleStr :str) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
421 if getElementById(reactionId, metabMap).map(lambda el : styleMapElement(el, styleStr)).isErr:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
422 ERRORS.append(reactionId)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
423
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
424 def styleReactionElements(self, metabMap :ET.ElementTree, reactionId :str, *, mindReactionDir = True) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
425 # If We're dealing with RAS data or in general don't care about the direction of the reaction we only style the arrow body
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
426 if not mindReactionDir:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
427 return self.applyTo(getArrowBodyElementId(reactionId), metabMap, self.toStyleStr())
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
428
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
429 # Now we style the arrow head(s):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
430 idOpt1, idOpt2 = getArrowHeadElementId(reactionId)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
431 self.applyTo(idOpt1, metabMap, self.toStyleStr(downSizedForTips = True))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
432 if idOpt2: self.applyTo(idOpt2, metabMap, self.toStyleStr(downSizedForTips = True))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
433
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
434 def getMapReactionId(self, reactionId :str, mindReactionDir :bool) -> str:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
435 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
436 Computes the reaction ID as encoded in the map for a given reaction ID from the dataset.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
437
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
438 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
439 reactionId: the reaction ID, as encoded in the dataset.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
440 mindReactionDir: if True forward (F_) and backward (B_) directions will be encoded in the result.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
441
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
442 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
443 str : the ID of an arrow's body or tips in the map.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
444 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
445 # we assume the reactionIds also don't encode reaction dir if they don't mind it when styling the map.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
446 if not mindReactionDir: return "R_" + reactionId
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
447
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
448 #TODO: this is clearly something we need to make consistent in RPS
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
449 return (reactionId[:-3:-1] + reactionId[:-2]) if reactionId[:-2] in ["_F", "_B"] else f"F_{reactionId}" # "Pyr_F" --> "F_Pyr"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
450
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
451 def toStyleStr(self, *, downSizedForTips = False) -> str:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
452 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
453 Collapses the styles of this Arrow into a str, ready to be applied as part of the "style" property on an svg element.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
454
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
455 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
456 str : the styles string.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
457 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
458 width = self.w
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
459 if downSizedForTips: width *= 0.8
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
460 return f";stroke:{self.col};stroke-width:{width};stroke-dasharray:{'5,5' if self.dash else 'none'}"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
461
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
462 # vvv These constants could be inside the class itself a static properties, but python
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
463 # was built by brainless organisms so here we are!
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
464 INVALID_ARROW = Arrow(Arrow.MIN_W, ArrowColor.Invalid)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
465 INSIGNIFICANT_ARROW = Arrow(Arrow.MIN_W, ArrowColor.Invalid, isDashed = True)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
466
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
467 def applyRpsEnrichmentToMap(rpsEnrichmentRes :Dict[str, Union[Tuple[float, FoldChange], Tuple[float, FoldChange, float, float]]], metabMap :ET.ElementTree, maxNumericZScore :float) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
468 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
469 Applies RPS enrichment results to the provided metabolic map.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
470
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
471 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
472 rpsEnrichmentRes : RPS enrichment results.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
473 metabMap : the metabolic map to edit.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
474 maxNumericZScore : biggest finite z-score value found.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
475
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
476 Side effects:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
477 metabMap : mut
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
478
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
479 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
480 None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
481 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
482 for reactionId, values in rpsEnrichmentRes.items():
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
483 pValue = values[0]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
484 foldChange = values[1]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
485 z_score = values[2]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
486
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
487 if isinstance(foldChange, str): foldChange = float(foldChange)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
488 if pValue >= ARGS.pValue: # pValue above tresh: dashed arrow
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
489 INSIGNIFICANT_ARROW.styleReactionElements(metabMap, reactionId)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
490 continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
491
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
492 if abs(foldChange) < (ARGS.fChange - 1) / (abs(ARGS.fChange) + 1):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
493 INVALID_ARROW.styleReactionElements(metabMap, reactionId)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
494 continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
495
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
496 width = Arrow.MAX_W
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
497 if not math.isinf(foldChange):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
498 try: width = max(abs(z_score * Arrow.MAX_W) / maxNumericZScore, Arrow.MIN_W)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
499 except ZeroDivisionError: pass
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
500
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
501 if not reactionId.endswith("_RV"): # RV stands for reversible reactions
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
502 Arrow(width, ArrowColor.fromFoldChangeSign(foldChange)).styleReactionElements(metabMap, reactionId)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
503 continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
504
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
505 reactionId = reactionId[:-3] # Remove "_RV"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
506
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
507 inversionScore = (values[3] < 0) + (values[4] < 0) # Compacts the signs of averages into 1 easy to check score
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
508 if inversionScore == 2: foldChange *= -1
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
509 # ^^^ Style the inverse direction with the opposite sign netValue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
510
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
511 # If the score is 1 (opposite signs) we use alternative colors vvv
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
512 arrow = Arrow(width, ArrowColor.fromFoldChangeSign(foldChange, useAltColor = inversionScore == 1))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
513
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
514 # vvv These 2 if statements can both be true and can both happen
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
515 if ARGS.net: # style arrow head(s):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
516 arrow.styleReactionElements(metabMap, reactionId + ("_B" if inversionScore == 2 else "_F"))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
517
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
518 if not ARGS.using_RAS: # style arrow body
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
519 arrow.styleReactionElements(metabMap, reactionId, mindReactionDir = False)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
520
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
521 ############################ split class ######################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
522 def split_class(classes :pd.DataFrame, resolve_rules :Dict[str, List[float]]) -> Dict[str, List[List[float]]]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
523 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
524 Generates a :dict that groups together data from a :DataFrame based on classes the data is related to.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
525
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
526 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
527 classes : a :DataFrame of only string values, containing class information (rows) and keys to query the resolve_rules :dict
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
528 resolve_rules : a :dict containing :float data
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
529
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
530 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
531 dict : the dict with data grouped by class
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
532
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
533 Side effects:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
534 classes : mut
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
535 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
536 class_pat :Dict[str, List[List[float]]] = {}
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
537 for i in range(len(classes)):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
538 classe :str = classes.iloc[i, 1]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
539 if pd.isnull(classe): continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
540
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
541 l :List[List[float]] = []
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
542 for j in range(i, len(classes)):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
543 if classes.iloc[j, 1] == classe:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
544 pat_id :str = classes.iloc[j, 0]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
545 tmp = resolve_rules.get(pat_id, None)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
546 if tmp != None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
547 l.append(tmp)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
548 classes.iloc[j, 1] = None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
549
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
550 if l:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
551 class_pat[classe] = list(map(list, zip(*l)))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
552 continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
553
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
554 utils.logWarning(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
555 f"Warning: no sample found in class \"{classe}\", the class has been disregarded", ARGS.out_log)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
556
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
557 return class_pat
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
558
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
559 ############################ conversion ##############################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
560 #conversion from svg to png
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
561 def svg_to_png_with_background(svg_path :utils.FilePath, png_path :utils.FilePath, dpi :int = 72, scale :int = 1, size :Optional[float] = None) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
562 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
563 Internal utility to convert an SVG to PNG (forced opaque) to aid in PDF conversion.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
564
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
565 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
566 svg_path : path to SVG file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
567 png_path : path for new PNG file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
568 dpi : dots per inch of the generated PNG
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
569 scale : scaling factor for the generated PNG, computed internally when a size is provided
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
570 size : final effective width of the generated PNG
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
571
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
572 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
573 None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
574 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
575 if size:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
576 image = pyvips.Image.new_from_file(svg_path.show(), dpi=dpi, scale=1)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
577 scale = size / image.width
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
578 image = image.resize(scale)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
579 else:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
580 image = pyvips.Image.new_from_file(svg_path.show(), dpi=dpi, scale=scale)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
581
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
582 white_background = pyvips.Image.black(image.width, image.height).new_from_image([255, 255, 255])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
583 white_background = white_background.affine([scale, 0, 0, scale])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
584
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
585 if white_background.bands != image.bands:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
586 white_background = white_background.extract_band(0)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
587
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
588 composite_image = white_background.composite2(image, 'over')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
589 composite_image.write_to_file(png_path.show())
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
590
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
591 #funzione unica, lascio fuori i file e li passo in input
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
592 #conversion from png to pdf
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
593 def convert_png_to_pdf(png_file :utils.FilePath, pdf_file :utils.FilePath) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
594 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
595 Internal utility to convert a PNG to PDF to aid from SVG conversion.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
596
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
597 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
598 png_file : path to PNG file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
599 pdf_file : path to new PDF file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
600
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
601 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
602 None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
603 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
604 image = Image.open(png_file.show())
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
605 image = image.convert("RGB")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
606 image.save(pdf_file.show(), "PDF", resolution=100.0)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
607
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
608 #function called to reduce redundancy in the code
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
609 def convert_to_pdf(file_svg :utils.FilePath, file_png :utils.FilePath, file_pdf :utils.FilePath) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
610 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
611 Converts the SVG map at the provided path to PDF.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
612
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
613 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
614 file_svg : path to SVG file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
615 file_png : path to PNG file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
616 file_pdf : path to new PDF file
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
617
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
618 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
619 None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
620 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
621 svg_to_png_with_background(file_svg, file_png)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
622 try:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
623 convert_png_to_pdf(file_png, file_pdf)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
624 print(f'PDF file {file_pdf.filePath} successfully generated.')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
625
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
626 except Exception as e:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
627 raise utils.DataErr(file_pdf.show(), f'Error generating PDF file: {e}')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
628
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
629 ############################ map ##############################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
630 def buildOutputPath(dataset1Name :str, dataset2Name = "rest", *, details = "", ext :utils.FileFormat) -> utils.FilePath:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
631 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
632 Builds a FilePath instance from the names of confronted datasets ready to point to a location in the
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
633 "result/" folder, used by this tool for output files in collections.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
634
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
635 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
636 dataset1Name : _description_
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
637 dataset2Name : _description_. Defaults to "rest".
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
638 details : _description_
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
639 ext : _description_
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
640
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
641 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
642 utils.FilePath : _description_
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
643 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
644 # This function returns a util data structure but is extremely specific to this module.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
645 # RAS also uses collections as output and as such might benefit from a method like this, but I'd wait
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
646 # TODO: until a third tool with multiple outputs appears before porting this to utils.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
647 return utils.FilePath(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
648 f"{dataset1Name}_vs_{dataset2Name}" + (f" ({details})" if details else ""),
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
649 # ^^^ yes this string is built every time even if the form is the same for the same 2 datasets in
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
650 # all output files: I don't care, this was never the performance bottleneck of the tool and
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
651 # there is no other net gain in saving and re-using the built string.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
652 ext,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
653 prefix = "result")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
654
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
655 FIELD_NOT_AVAILABLE = '/'
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
656 def writeToCsv(rows: List[list], fieldNames :List[str], outPath :utils.FilePath) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
657 fieldsAmt = len(fieldNames)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
658 with open(outPath.show(), "w", newline = "") as fd:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
659 writer = csv.DictWriter(fd, fieldnames = fieldNames, delimiter = '\t')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
660 writer.writeheader()
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
661
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
662 for row in rows:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
663 sizeMismatch = fieldsAmt - len(row)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
664 if sizeMismatch > 0: row.extend([FIELD_NOT_AVAILABLE] * sizeMismatch)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
665 writer.writerow({ field : data for field, data in zip(fieldNames, row) })
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
666
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
667 OldEnrichedScores = Dict[str, List[Union[float, FoldChange]]] #TODO: try to use Tuple whenever possible
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
668 def writeTabularResult(enrichedScores : OldEnrichedScores, ras_enrichment: bool, outPath :utils.FilePath) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
669 fieldNames = ["ids", "P_Value", "fold change"]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
670 if not ras_enrichment: fieldNames.extend(["average_1", "average_2"])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
671
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
672 writeToCsv([ [reactId] + values for reactId, values in enrichedScores.items() ], fieldNames, outPath)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
673
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
674 def temp_thingsInCommon(tmp :Dict[str, List[Union[float, FoldChange]]], core_map :ET.ElementTree, max_z_score :float, dataset1Name :str, dataset2Name = "rest", ras_enrichment = True) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
675 # this function compiles the things always in common between comparison modes after enrichment.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
676 # TODO: organize, name better.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
677 writeTabularResult(tmp, ras_enrichment, buildOutputPath(dataset1Name, dataset2Name, details = "Tabular Result", ext = utils.FileFormat.TSV))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
678
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
679 if ras_enrichment:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
680 fix_map(tmp, core_map, ARGS.pValue, ARGS.fChange, max_z_score)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
681 return
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
682
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
683 for reactId, enrichData in tmp.items(): tmp[reactId] = tuple(enrichData)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
684 applyRpsEnrichmentToMap(tmp, core_map, max_z_score)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
685
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
686 def computePValue(dataset1Data: List[float], dataset2Data: List[float]) -> Tuple[float, float]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
687 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
688 Computes the statistical significance score (P-value) of the comparison between coherent data
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
689 from two datasets. The data is supposed to, in both datasets:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
690 - be related to the same reaction ID;
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
691 - be ordered by sample, such that the item at position i in both lists is related to the
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
692 same sample or cell line.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
693
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
694 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
695 dataset1Data : data from the 1st dataset.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
696 dataset2Data : data from the 2nd dataset.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
697
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
698 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
699 tuple: (P-value, Z-score)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
700 - P-value from a Kolmogorov-Smirnov test on the provided data.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
701 - Z-score of the difference between means of the two datasets.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
702 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
703 # Perform Kolmogorov-Smirnov test
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
704 ks_statistic, p_value = st.ks_2samp(dataset1Data, dataset2Data)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
705
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
706 # Calculate means and standard deviations
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
707 mean1 = np.mean(dataset1Data)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
708 mean2 = np.mean(dataset2Data)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
709 std1 = np.std(dataset1Data, ddof=1)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
710 std2 = np.std(dataset2Data, ddof=1)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
711
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
712 n1 = len(dataset1Data)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
713 n2 = len(dataset2Data)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
714
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
715 # Calculate Z-score
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
716 z_score = (mean1 - mean2) / np.sqrt((std1**2 / n1) + (std2**2 / n2))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
717
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
718 return p_value, z_score
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
719
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
720 def compareDatasetPair(dataset1Data :List[List[float]], dataset2Data :List[List[float]], ids :List[str]) -> Tuple[Dict[str, List[Union[float, FoldChange]]], float]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
721 #TODO: the following code still suffers from "dumbvarnames-osis"
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
722 tmp :Dict[str, List[Union[float, FoldChange]]] = {}
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
723 count = 0
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
724 max_z_score = 0
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
725
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
726 for l1, l2 in zip(dataset1Data, dataset2Data):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
727 reactId = ids[count]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
728 count += 1
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
729 if not reactId: continue # we skip ids that have already been processed
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
730
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
731 try: #TODO: identify the source of these errors and minimize code in the try block
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
732 reactDir = ReactionDirection.fromReactionId(reactId)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
733 # Net score is computed only for reversible reactions when user wants it on arrow tips or when RAS datasets aren't used
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
734 if (ARGS.net or not ARGS.using_RAS) and reactDir is not ReactionDirection.Unknown:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
735 try: position = ids.index(reactId[:-1] + ('B' if reactDir is ReactionDirection.Direct else 'F'))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
736 except ValueError: continue # we look for the complementary id, if not found we skip
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
737
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
738 nets1 = np.subtract(l1, dataset1Data[position])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
739 nets2 = np.subtract(l2, dataset2Data[position])
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
740
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
741 p_value, z_score = computePValue(nets1, nets2)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
742 avg1 = sum(nets1) / len(nets1)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
743 avg2 = sum(nets2) / len(nets2)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
744 net = fold_change(avg1, avg2)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
745
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
746 if math.isnan(net): continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
747 tmp[reactId[:-1] + "RV"] = [p_value, net, z_score, avg1, avg2]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
748
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
749 # vvv complementary directional ids are set to None once processed if net is to be applied to tips
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
750 if ARGS.net:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
751 ids[position] = None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
752 continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
753
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
754 # fallthrough is intended, regular scores need to be computed when tips aren't net but RAS datasets aren't used
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
755 p_value, z_score = computePValue(l1, l2)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
756 avg = fold_change(sum(l1) / len(l1), sum(l2) / len(l2))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
757 if not isinstance(z_score, str) and max_z_score < abs(z_score): max_z_score = abs(z_score)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
758 tmp[reactId] = [float(p_value), avg, z_score]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
759
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
760 except (TypeError, ZeroDivisionError): continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
761
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
762 return tmp, max_z_score
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
763
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
764 def computeEnrichment(metabMap :ET.ElementTree, class_pat :Dict[str, List[List[float]]], ids :List[str], *, fromRAS = True) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
765 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
766 Compares clustered data based on a given comparison mode and applies enrichment-based styling on the
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
767 provided metabolic map.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
768
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
769 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
770 metabMap : SVG map to modify.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
771 class_pat : the clustered data.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
772 ids : ids for data association.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
773 fromRAS : whether the data to enrich consists of RAS scores.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
774
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
775 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
776 None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
777
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
778 Raises:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
779 sys.exit : if there are less than 2 classes for comparison
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
780
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
781 Side effects:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
782 metabMap : mut
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
783 ids : mut
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
784 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
785 class_pat = { k.strip() : v for k, v in class_pat.items() }
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
786 #TODO: simplfy this stuff vvv and stop using sys.exit (raise the correct utils error)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
787 if (not class_pat) or (len(class_pat.keys()) < 2): sys.exit('Execution aborted: classes provided for comparisons are less than two\n')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
788
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
789 if ARGS.comparison == "manyvsmany":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
790 for i, j in it.combinations(class_pat.keys(), 2):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
791 #TODO: these 2 functions are always called in pair and in this order and need common data,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
792 # some clever refactoring would be appreciated.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
793 comparisonDict, max_z_score = compareDatasetPair(class_pat.get(i), class_pat.get(j), ids)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
794 temp_thingsInCommon(comparisonDict, metabMap, max_z_score, i, j, fromRAS)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
795
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
796 elif ARGS.comparison == "onevsrest":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
797 for single_cluster in class_pat.keys():
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
798 t :List[List[List[float]]] = []
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
799 for k in class_pat.keys():
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
800 if k != single_cluster:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
801 t.append(class_pat.get(k))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
802
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
803 rest :List[List[float]] = []
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
804 for i in t:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
805 rest = rest + i
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
806
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
807 comparisonDict, max_z_score = compareDatasetPair(class_pat.get(single_cluster), rest, ids)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
808 temp_thingsInCommon(comparisonDict, metabMap, max_z_score, single_cluster, fromRAS)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
809
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
810 elif ARGS.comparison == "onevsmany":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
811 controlItems = class_pat.get(ARGS.control)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
812 for otherDataset in class_pat.keys():
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
813 if otherDataset == ARGS.control: continue
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
814
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
815 comparisonDict, max_z_score = compareDatasetPair(controlItems, class_pat.get(otherDataset), ids)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
816 temp_thingsInCommon(comparisonDict, metabMap, max_z_score, ARGS.control, otherDataset, fromRAS)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
817
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
818 def createOutputMaps(dataset1Name :str, dataset2Name :str, core_map :ET.ElementTree) -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
819 svgFilePath = buildOutputPath(dataset1Name, dataset2Name, details = "SVG Map", ext = utils.FileFormat.SVG)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
820 utils.writeSvg(svgFilePath, core_map)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
821
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
822 if ARGS.generate_pdf:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
823 pngPath = buildOutputPath(dataset1Name, dataset2Name, details = "PNG Map", ext = utils.FileFormat.PNG)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
824 pdfPath = buildOutputPath(dataset1Name, dataset2Name, details = "PDF Map", ext = utils.FileFormat.PDF)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
825 convert_to_pdf(svgFilePath, pngPath, pdfPath)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
826
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
827 if not ARGS.generate_svg: os.remove(svgFilePath.show())
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
828
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
829 ClassPat = Dict[str, List[List[float]]]
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
830 def getClassesAndIdsFromDatasets(datasetsPaths :List[str], datasetPath :str, classPath :str, names :List[str]) -> Tuple[List[str], ClassPat]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
831 # TODO: I suggest creating dicts with ids as keys instead of keeping class_pat and ids separate,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
832 # for the sake of everyone's sanity.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
833 class_pat :ClassPat = {}
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
834 if ARGS.option == 'datasets':
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
835 num = 1 #TODO: the dataset naming function could be a generator
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
836 for path, name in zip(datasetsPaths, names):
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
837 name = name_dataset(name, num)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
838 resolve_rules_float, ids = getDatasetValues(path, name)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
839 if resolve_rules_float != None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
840 class_pat[name] = list(map(list, zip(*resolve_rules_float.values())))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
841
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
842 num += 1
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
843
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
844 elif ARGS.option == "dataset_class":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
845 classes = read_dataset(classPath, "class")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
846 classes = classes.astype(str)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
847
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
848 resolve_rules_float, ids = getDatasetValues(datasetPath, "Dataset Class (not actual name)")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
849 if resolve_rules_float != None: class_pat = split_class(classes, resolve_rules_float)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
850
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
851 return ids, class_pat
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
852 #^^^ TODO: this could be a match statement over an enum, make it happen future marea dev with python 3.12! (it's why I kept the ifs)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
853
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
854 #TODO: create these damn args as FilePath objects
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
855 def getDatasetValues(datasetPath :str, datasetName :str) -> Tuple[ClassPat, List[str]]:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
856 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
857 Opens the dataset at the given path and extracts the values (expected nullable numerics) and the IDs.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
858
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
859 Args:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
860 datasetPath : path to the dataset
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
861 datasetName (str): dataset name, used in error reporting
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
862
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
863 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
864 Tuple[ClassPat, List[str]]: values and IDs extracted from the dataset
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
865 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
866 dataset = read_dataset(datasetPath, datasetName)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
867 IDs = pd.Series.tolist(dataset.iloc[:, 0].astype(str))
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
868
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
869 dataset = dataset.drop(dataset.columns[0], axis = "columns").to_dict("list")
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
870 return { id : list(map(utils.Float("Dataset values, not an argument"), values)) for id, values in dataset.items() }, IDs
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
871
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
872 ############################ MAIN #############################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
873 def main() -> None:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
874 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
875 Initializes everything and sets the program in motion based on the fronted input arguments.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
876
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
877 Returns:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
878 None
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
879
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
880 Raises:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
881 sys.exit : if a user-provided custom map is in the wrong format (ET.XMLSyntaxError, ET.XMLSchemaParseError)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
882 """
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
883
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
884 global ARGS
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
885 ARGS = process_args()
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
886
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
887 if os.path.isdir('result') == False: os.makedirs('result')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
888
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
889 core_map :ET.ElementTree = ARGS.choice_map.getMap(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
890 ARGS.tool_dir,
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
891 utils.FilePath.fromStrPath(ARGS.custom_map) if ARGS.custom_map else None)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
892 # TODO: ^^^ ugly but fine for now, the argument is None if the model isn't custom because no file was given.
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
893 # getMap will None-check the customPath and panic when the model IS custom but there's no file (good). A cleaner
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
894 # solution can be derived from my comment in FilePath.fromStrPath
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
895
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
896 if ARGS.using_RAS:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
897 ids, class_pat = getClassesAndIdsFromDatasets(ARGS.input_datas, ARGS.input_data, ARGS.input_class, ARGS.names)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
898 computeEnrichment(core_map, class_pat, ids)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
899
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
900 if ARGS.using_RPS:
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
901 ids, class_pat = getClassesAndIdsFromDatasets(ARGS.input_datas_rps, ARGS.input_data_rps, ARGS.input_class_rps, ARGS.names_rps)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
902 computeEnrichment(core_map, class_pat, ids, fromRAS = False)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
903
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
904 # create output files: TODO: this is the same comparison happening in "maps", find a better way to organize this
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
905 if ARGS.comparison == "manyvsmany":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
906 for i, j in it.combinations(class_pat.keys(), 2): createOutputMaps(i, j, core_map)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
907 return
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
908
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
909 if ARGS.comparison == "onevsrest":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
910 for single_cluster in class_pat.keys(): createOutputMaps(single_cluster, "rest", core_map)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
911 return
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
912
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
913 for otherDataset in class_pat.keys():
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
914 if otherDataset != ARGS.control: createOutputMaps(i, j, core_map)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
915
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
916 if not ERRORS: return
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
917 utils.logWarning(
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
918 f"The following reaction IDs were mentioned in the dataset but weren't found in the map: {ERRORS}",
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
919 ARGS.out_log)
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
920
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
921 print('Execution succeded')
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
922
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
923 ###############################################################################
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
924 if __name__ == "__main__":
41f35c2f0c7b Uploaded
luca_milaz
parents:
diff changeset
925 main()