def test_check_delimiter(self):
'''
test if the delimiter can be determined
'''
for sbtab in self.sbtabs:
self.assertNotEqual(misc.check_delimiter(sbtab.to_str()), False)
for doc in self.docs:
for sbtab in doc.sbtabs:
self.assertNotEqual(misc.check_delimiter(sbtab.to_str()), False)
for sbml in self.sbml_docs:
self.assertFalse(misc.check_delimiter(sbml))
def test_check_delimiter(self):
'''
test if the delimiter can be determined
'''
for sbtab in self.sbtabs:
self.assertNotEqual(misc.check_delimiter(sbtab.to_str()), False)
for doc in self.docs:
for sbtab in doc.sbtabs:
self.assertNotEqual(misc.check_delimiter(sbtab.to_str()),
False)
for sbml in self.sbml_docs:
self.assertFalse(misc.check_delimiter(sbml))
def __init__(self, table_string, filename):
'''
Creates SBtab Python object from tablib object.
Parameters
----------
table : str
Containing one SBtab, uncut. Directly from f.read().
filename : str
Filename with extension.
'''
# Needed to be able to adress it from outside of the class for
# writing and reading
self.filename = filename
# validate file extension
self.validate_extension()
# process string
self.delimiter = misc.check_delimiter(table_string)
table_list = self.cut_table_string(table_string)
# check if ascii stuff is violated
try: (self.table, self.str_tab) = self.check_ascii(table_list)
except: raise SBtabError('''This is not a valid SBtab file. Try to
check your file with the SBtab validator or read the
SBtab specification.''')
# Delete tablib header to avoid complications
if self.table.headers: self.table.headers = None
# Create all necessary variables
self.tables_without_name = []
self.initialize_table()
self.sbtab_dataset = []
def initialize_table(self):
'''
Loads table informations and class variables.
'''
# read a potential document row
self.doc_row = self._get_doc_row()
# Read the header row from table
self.header_row = self._get_header_row()
# Read the table information from header row
(self.table_type,
self.table_name,
self.table_document,
self.table_version) = self.get_table_information()
# Read the columns of the table
(self.columns, self.columns_dict) = self.get_columns()
self.delimiter = misc.check_delimiter('\n'.join(self.str_tab))
# Read data rows
self.value_rows = self.get_rows(self.table_type)
# Update the list and tablib object
self.update()
def __init__(self, table_string, filename):
'''
Creates SBtab table object from string.
Parameters
----------
table : str
One SBtab string from read file.
filename : str
Filename with extension.
'''
self.filename = filename
self.table_string = table_string
# validate file extension
self._validate_extension()
# validate singular SBtab
self._singular()
# process string
self.delimiter = misc.check_delimiter(table_string)
self.preprocess = self._preprocess_table_string(table_string)
self.table = self._cut_table_string(self.preprocess)
# Initialise table
self._initialize_table()
self.object_type = 'table'
def __init__(self, table_string, filename):
'''
Creates SBtab table object from string.
Parameters
----------
table : str
One SBtab string from read file.
filename : str
Filename with extension.
'''
self.filename = filename
self.table_string = table_string
# validate file extension
self._validate_extension()
# validate singular SBtab
self._singular()
# process string
self.delimiter = misc.check_delimiter(table_string)
self.preprocess = self._preprocess_table_string(table_string)
self.table = self._cut_table_string(self.preprocess)
# Initialise table
self._initialize_table()
self.object_type = 'table'
def importSetNew(sbtabfile, filename, separator=None):
mimetypes.init()
file_mimetype = mimetypes.guess_type(filename)[0]
if separator:
return haveTSV(sbtabfile, separator)
elif file_mimetype == 'application/vnd.ms-excel' or file_mimetype == 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' or file_mimetype == 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
return haveXLS(sbtabfile, True, True)
else:
separator = misc.check_delimiter(sbtabfile)
return haveTSV(sbtabfile, separator)
'''
def importSetNew(sbtabfile,filename,separator=None):
mimetypes.init()
file_mimetype = mimetypes.guess_type(filename)[0]
if separator:
return haveTSV(sbtabfile,separator)
elif file_mimetype == 'application/vnd.ms-excel' or file_mimetype == 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' or file_mimetype == 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
return haveXLS(sbtabfile, True, True)
else:
separator = misc.check_delimiter(sbtabfile)
return haveTSV(sbtabfile, separator)
'''
def add_sbtab_string(self, sbtab_string, definitions_file=None):
'''
Sets the content of the SBtab Table in form of a string
'''
self.table_string = sbtab_string
# validate singular SBtab
self._singular()
# process string
self.delimiter = misc.check_delimiter(sbtab_string)
self.preprocess = self._preprocess_table_string(sbtab_string)
self.table = self._cut_table_string(self.preprocess)
# Initialise table
self._initialize_table()
def parameter_balancing_wrapper(sbml, sbtab_data_name=None, sbtab_prior_name=None, sbtab_options_name=None, verbose=False, no_pseudo_values=False, output_name=None, pb_log=False, concat=False):
'''
wrapper for parameter balancing.
Parameters
==========
sbml: string (path to sbml file)
sbtab_data_name: string (path to sbtab data file)
sbtab_prior_name: string (path to sbtab prior file)
sbtab_options_name: string (path to sbtab options file)
verbose: Boolean (enable messages on commandline)
no_pseudo_values: Boolean (disable usage of pseudo values)
output_name: string (name for the output files)
pb_log: Boolean (enable writing of a log file)
concat: Boolean (enable writing of concatenation input/output file)
'''
model_name = sbml
parameter_dict = {}
log_file = 'Parameter balancing log file of model %s\n' % (model_name)
warn_flag = False
###########################
# 1: open and prepare the files; then check for some rudimentary validity:
# 1.1: SBML model
reader = libsbml.SBMLReader()
try: sbml_file = reader.readSBML(model_name)
except:
print('The SBML file %s could not be found.' % (model_name))
sys.exit()
try: sbml_model = sbml_file.getModel()
except:
print('The SBML file %s is corrupt. I quit.' % (model_name))
sys.exit()
valid_extension = misc.validate_file_extension(model_name, 'sbml')
if not valid_extension:
print('The SBML file %s has not the correct xml extension'\
'. I quit.''' % (model_name))
sys.exit()
if sbml_model.getNumReactions() > 250:
print('The given model has more than 250 reactions and we '\
'do not recommend employing models that large for '\
'parameter balancing.')
sys.exit()
pb = balancer.ParameterBalancing(sbml_model)
###########################
# 1.2: open and prepare the optional SBtab data file
if sbtab_data_name:
valid_extension = misc.validate_file_extension(sbtab_data_name,
'sbtab')
if not valid_extension:
print('The SBtab data file %s has not the correct file '\
'extension.' % (sbtab_data_name))
try:
f = open(sbtab_data_name, 'r')
f_content = f.read()
except:
print('The SBtab data file %s cannot be found or'\
'read.' % sbtab_data_name)
try: sbtab_delimiter = misc.check_delimiter(f_content)
except: sbtab_delimiter = '\t'
sbtab_data = SBtab.SBtabTable(f_content, sbtab_data_name)
sbtab_data_validate = validatorSBtab.ValidateTable(sbtab_data)
warnings = sbtab_data_validate.return_output()
if warnings != []:
warn_flag = True
log_file += 'Log warnings for SBtab data file: '\
'%s\n' % sbtab_data_name
for warning in warnings:
log_file += warning + '\n'
#print(sbtab_data.value_rows)
###########################
# 1.3: open and prepare an optional SBtab prior file;
# if this is not provided, open the default prior file
if sbtab_prior_name:
# try to open and read the file
valid_extension = misc.validate_file_extension(sbtab_prior_name,
'sbtab')
if not valid_extension:
print('The SBtab prior file %s has not the correct file'\
'extension.' % (sbtab_prior_name))
try:
f = open(sbtab_prior_name, 'r')
f_content = f.read()
except:
print('The SBtab prior file %s cannot be found or'\
'read.' % sbtab_prior_name)
# initialise an SBtab object with the content and check its validity
sbtab_prior = SBtab.SBtabTable(f_content, sbtab_prior_name)
pb.get_parameter_information(sbtab_prior)
sbtab_prior_validate = validatorSBtab.ValidateTable(sbtab_prior)
# register warnings
warnings = sbtab_prior_validate.return_output()
if warnings != []:
warn_flag = True
log_file += 'Log warnings for SBtab prior file: '\
'%s\n\n' % sbtab_prior_name
for warning in warnings:
log_file += warning + '\n'
valid_prior = misc.valid_prior(sbtab_prior)
if valid_prior != []:
warn_flag = True
log_file += 'Log warnings for SBtab prior file: '\
'%s\n\n' % sbtab_prior_name
for element in valid_prior:
log_file += str(element) + '\n'
# extract crucial information from prior
(pseudos, priors, pmin, pmax) = misc.extract_pseudos_priors(sbtab_prior)
else:
# open default prior file
p = os.path.dirname(os.path.abspath(__file__)) + '/files/default_'\
'files/pb_prior.tsv'
try:
prior_file = open(p, 'r')
prior = prior_file.read()
except:
print('The prior file (/files/default_files/pb_prior.tsv) coul'\
'd not be found. I quit.')
sys.exit()
sbtab_prior = SBtab.SBtabTable(prior, 'pb_prior.tsv')
sbtab_prior_validate = validatorSBtab.ValidateTable(sbtab_prior)
# register warnings
warnings = sbtab_prior_validate.return_output()
if warnings != []:
warn_flag = True
log_file += 'Log warnings for SBtab prior file: '\
'%s\n\n' % sbtab_prior_name
for warning in warnings:
log_file += warning + '\n'
valid_prior = misc.valid_prior(sbtab_prior)
if valid_prior != []:
warn_flag = True
log_file += 'Log warnings for SBtab prior file: '\
'%s\n\n' % sbtab_prior_name
for element in valid_prior:
log_file += str(element) + '\n'
# extract crucial information from prior
(pseudos, priors, pmin, pmax) = misc.extract_pseudos_priors(sbtab_prior)
###########################
# 1.4: open and prepare an optional SBtab options file;
# if this is not provided, open the default options file
if sbtab_options_name:
valid_extension = misc.validate_file_extension(sbtab_options_name, 'sbtab')
if not valid_extension:
print('The SBtab options file %s has not the correct file'\
' extension.' % (sbtab_options_name))
try:
f = open(sbtab_options_name, 'r')
f_content = f.read()
except:
print('The SBtab options file %s cannot be found or'\
'read.' % sbtab_options_name)
sbtab_options = SBtab.SBtabTable(f_content, sbtab_options_name)
sbtab_options_validate = validatorSBtab.ValidateTable(sbtab_options)
# register warnings
warnings = sbtab_options_validate.return_output()
if warnings != []:
warn_flag = True
log_file += 'Log warnings for SBtab options file: '\
'%s\n\n' % sbtab_options_name
for warning in warnings:
log_file += warning + '\n'
(parameter_dict, log) = misc.readout_config(sbtab_options)
if log != []:
warn_flag = True
log_file += 'Log warnings for SBtab options file: '\
'%s\n\n' % sbtab_options_name
for element in log:
log_file += str(element) + '\n'
else:
o = os.path.dirname(os.path.abspath(__file__)) + '/files/default_'\
'files/pb_options.tsv'
try:
options_file = open(o, 'r')
f_content = options_file.read()
except:
print('The options file (/files/default_files/pb_options.tsv) coul'\
'd not be found. I quit.')
sys.exit()
sbtab_options = SBtab.SBtabTable(f_content, 'pb_options.tsv')
sbtab_options_validate = validatorSBtab.ValidateTable(sbtab_options)
# register warnings
warnings = sbtab_options_validate.return_output()
if warnings != []:
warn_flag = True
log_file += 'Log warnings for SBtab options file: '\
'pb_options.tsv\n\n'
for warning in warnings:
log_file += warning + '\n'
(parameter_dict, log) = misc.readout_config(sbtab_options)
if log != []:
warn_flag = True
log_file += 'Log warnings for SBtab options file: '\
'%s\n\n' % sbtab_options_name
for element in log:
log_file += str(element) + '\n'
# Make empty SBtab if required
if sbtab_data_name:
sbtab = pb.make_sbtab(sbtab_data, sbtab_data_name, 'All organisms', 43,
pmin, pmax, parameter_dict)
sbtabid2sbmlid = misc.id_checker(sbtab, sbml_model)
if sbtabid2sbmlid != []:
warn_flag = True
log_file += 'Log warnings for SBtab data file: '\
'%s\n\n' % sbtab_data_name
for element in sbtabid2sbmlid:
log_file += element + '\n'
else:
sbtab = pb.make_empty_sbtab(pmin, pmax, parameter_dict)
# end of file read in and processing;
# now verify that all required keys are given for the parameter_dict;
# if not, add them
if 'temperature' not in parameter_dict.keys():
parameter_dict['temperature'] = 300
if 'ph' not in parameter_dict.keys(): parameter_dict['ph'] = 7
if 'standard chemical potential' not in parameter_dict.keys():
parameter_dict['standard chemical potential'] = True
if 'catalytic rate constant geometric mean' not in parameter_dict.keys():
parameter_dict['catalytic rate constant geometric mean'] = True
if 'Michaelis constant' not in parameter_dict.keys():
parameter_dict['Michaelis constant'] = True
if 'activation constant' not in parameter_dict.keys():
parameter_dict['activation constant'] = True
if 'inhibitory constant' not in parameter_dict.keys():
parameter_dict['inhibitory constant'] = True
if 'concentration' not in parameter_dict.keys():
parameter_dict['concentration'] = True
if 'concentration of enzyme' not in parameter_dict.keys():
parameter_dict['concentration of enzyme'] = True
if 'equilibrium constant' not in parameter_dict.keys():
parameter_dict['equilibrium constant'] = True
if 'substrate catalytic rate constant' not in parameter_dict.keys():
parameter_dict['substrate catalytic rate constant'] = True
if 'product catalytic rate constant' not in parameter_dict.keys():
parameter_dict['product catalytic rate constant'] = True
if 'forward maximal velocity' not in parameter_dict.keys():
parameter_dict['forward maximal velocity'] = True
if 'reverse maximal velocity' not in parameter_dict.keys():
parameter_dict['reverse maximal velocity'] = True
if 'chemical potential' not in parameter_dict.keys():
parameter_dict['chemical potential'] = True
if 'reaction affinity' not in parameter_dict.keys():
parameter_dict['reaction affinity'] = True
if 'use_pseudo_values' not in parameter_dict.keys():
parameter_dict['use_pseudo_values'] = False
if verbose:
print('\nFiles successfully read. Start balancing.')
# 2: Parameter balancing
if parameter_dict['use_pseudo_values'] == 'True' and not no_pseudo_values:
sbtab_old = copy.deepcopy(sbtab)
sbtab_new = pb.fill_sbtab(sbtab_old, pseudos, priors)
pseudo_flag = 'pseudos'
if verbose:
print('Parameter balancing is using pseudo values.')
else:
sbtab_new = pb.fill_sbtab(sbtab)
pseudo_flag = 'no_pseudos'
if verbose:
print('Parameter balancing is not using pseudo values.')
(sbtab_final, mean_vector, mean_vector_inc, c_post, c_post_inc,
r_matrix, shannon, log, concat_file) = pb.make_balancing(sbtab_new,
sbtab, pmin,
pmax,
parameter_dict)
#for row in sbtab_final.value_rows:
# print(row)
log_file += '\n' + log + '\n'
# 3: inserting parameters and kinetics into SBML model
transfer_mode = {'standard chemical potential': 'weg',
'equilibrium constant': 'hal',
'catalytic rate constant': 'cat'}
try:
clear_mode = parameter_dict['parametrisation']
mode = transfer_mode[clear_mode]
except: mode = 'hal'
try: enzyme_prefac = parameter_dict['prefac']
except: enzyme_prefac = True
try: def_inh = parameter_dict['default_inh']
except: def_inh = 'complete_inh'
try: def_act = parameter_dict['default_act']
except: def_act = 'complete_act'
try: overwrite = parameter_dict['overwrite']
except: overwrite = True
kineticizer_cs = kineticizer.KineticizerCS(sbml_model, sbtab_final, mode,
enzyme_prefac, def_inh,
def_act, True)
if output_name:
output_name = output_name
else:
try: rm = re.match('.*/(.*)', str(model_name)).group(1)[:-4]
except: rm = str(model_name)[:-4]
output_name = rm + '_balanced'
if verbose:
print('Done... writing output files.')
if warn_flag:
print('The parameter balancing issued warnings. Please generate the '
'log file with the -l flag and check the warnings.')
# 5: If requested write log file
if pb_log:
if log_file.count('\n') == 2:
log_file += 'No warnings detected. \n'
log = open(output_name + '_log.txt', 'w')
log.write(log_file)
log.close()
if verbose:
print('The log file %s has been written.' % (output_name + '_log.txt'))
# 5b: If requested write output file with concatenated input/output files
if concat:
c_file = open(output_name + '_concat.tsv', 'w')
c_file.write(concat_file)
c_file.close()
if verbose:
print('The concat file %s has been written.' % (output_name + '_concat.tsv'))
# 6: Write SBtab and SBML model
sbtab_file_new = open(output_name + '.tsv', 'w')
sbtab_file_new.write(sbtab_final.to_str())
sbtab_file_new.close()
if verbose:
print('The SBtab file %s has been written.' % (output_name + '.tsv'))
sbml_code = '<?xml version="1.0" encoding="UTF-8"?>\n' + sbml_model.toSBML()
sbml_model_new = open(output_name + '.xml', 'w')
sbml_model_new.write(sbml_code)
sbml_model_new.close()
if verbose:
print('The SBML file %s has been written.' % (output_name + '.xml'))
print('>> Goodbye.')
return (sbml_model_new, sbtab_final)
return self.warnings
if __name__ == '__main__':
try: sys.argv[1]
except:
print('''You have not provided input arguments. Please start the script
by also providing an SBtab file and the required definition f
ile: >python validatorSBtab.py SBtab.csv definition.tsv''')
sys.exit()
file_name = sys.argv[1]
sbtab_file_o = open(file_name, 'r')
sbtab_file = sbtab_file_o.read()
sbtab_file_o.close()
delimiter = misc.check_delimiter(sbtab_file)
sbtab_tablib = tablibIO.importSetNew(sbtab_file, file_name, delimiter)
try:
default_def = sys.argv[2]
def_file = open(default_def, 'r')
def_tab = def_file.read()
def_file.close()
except:
def_tab = None
validator_output = []
Validate_file_class = ValidateFile(sbtab_file, file_name)
validator_output.append(Validate_file_class.return_output())
Validate_table_class = ValidateTable(sbtab_file, file_name, def_tab)
validator_output.append(Validate_table_class.return_output())
