7.1.1.3.1.3. cobramod.parsing.db_version

Database versioning configurator

This modules includes the class DataVersionConfigurator which is in charge of obtaining and comparing the version from the obtained metabolic data. It uses the same structure of using a Singleton for the configuration in COBRApy

7.1.1.3.1.3.1. Attributes

7.1.1.3.1.3.2. Classes

7.1.1.3.1.3.3. Module Contents

cobramod.parsing.db_version.debug_log
class cobramod.parsing.db_version.DataVersionConfigurator
get_database_version(directory)

Loads and returns the database versioning file.

Parameters:

directory (Path) – The folder used for storing data.

Returns:

A DataFrame containing the orgid and version, at

the time of the first retrieval, for all databases used so far.

Return type:

(pd.DataFrame)

get_local_databases(directory)
Parameters:

directory (Union[pathlib.Path, str])

Return type:

pandas.Series

check_database_version(directory, database, version)

Function to compare the saved database version with the one of the retrieved data.

Parameters:
  • directory (Path) – The folder used for storing data.

  • database (str) – Identifier of the database.

  • version (str) – The version of the database.

set_database_version(directory, database, version)

Adds the version of a database to the local data versioning file.

Parameters:
  • directory (Path) – The folder used for storing data.

  • database (str) – Identifier of the database.

  • version (str) – The version of the database.

Returns:

Returns True if the addition was successful.

Return type:

(bool)