--- a +++ b/README.md @@ -0,0 +1,22 @@ +# pyMultiOmics + +pyMultiOmics is a Python package for multi-omics data integration and analysis. +It uses the Reactome database to map entities (genes, transcripts, proteins, compounds) to +their reactions and pathways. The results is then shown as a network graph. Various analyses such as +differential analysis, pathway activity analysis can be performed on this network graph, with the results +overlaid on the graph. + +### Installation + +Simply run: +``` +pip install pyMultiOmics +``` + +For PDF report generation using nbconvert, make sure to install the required dependencies: + +https://nbconvert.readthedocs.io/en/latest/install.html + +### Usage + +[Notebooks to demonstrate various functionalities can be found here](https://github.com/glasgowcompbio/pyMultiOmics/blob/main/notebooks).