mergem 0.21

Merge two or more genome scale metabolic models.

mergem

mergem is a python package for merging genome-scale metabolic models. The package can be used as a command-line tool or can be imported within a python script.

---

Installation

To install the latest release

pip install mergem

---

Usage

For detailed usage instructions, please refer to the help documentation.

Command-line usage

Command-line options can be viewed using "--help" flag, as shown below:

> mergem --help
Usage: mergem [OPTIONS]

Options:
-i TEXT    Input model filenames
-obj TEXT  Set objective: 'merge' all objectives (default) or 1, 2, 3..
         (objective from one of the input models)
-o TEXT    Save model as (filename with format .xml, .sbml, etc.)
-v         Print merging statistics
-up        Update metabolite ID mapping table
--version  Show the version and exit.
--help     Show this message and exit.

For merging two models and setting objective of merged model from first model, use:

mergem -i model1.xml -i model2.xml -obj 1

To print merging statistics, append the "-v" flag:

mergem -i model1.xml -i model2.xml -obj 1 -v 

Importing mergem

To use mergem modules within a python script, simply import the package within the script:

import mergem

Provide the list of models to be merged as a list to the merge function:

merge_results = mergem.merge([model1, model2,..], objective)

where objective can be 'merge' or model index ('1', '2', '3', etc). The merge function returns a dictionary of results including the merged model, the metabolite and reaction jaccard distances of each model with respect to first model, and the metabolite and reaction model sources.

---

Citation

Please cite mergem using:

• mergem: A python package for the unification of genome scale metabolic models

---

---

Acknowledgements

This package was developed at The Lobo Lab, University of Maryland Baltimore County.

---

References

The following publications have contributed towards the development of this package:

• Fluxer: a web application to compute and visualize genome-scale metabolic flux networks.
• COBRApy: COnstraints-Based Reconstruction and Analysis for Python.

---

License

This package is under GNU GENERAL PUBLIC LICENSE. The package is free for use without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, subject to the following restrictions:

1. The origin of this software and database must not be misrepresented; you must not claim that you wrote the original software.
2. If you use this software and/or database in a work (any production in the scientific, literary, and artistic domain), an acknowledgment and citation (see publication above) in the work is required.
3. This notice may not be removed or altered from any distribution.