diff --git a/README.md b/README.md index f11085e..02da3ec 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A computational toolbox associated with the manuscript entitled "GEMCAT - A new algorithm for gene expression-based prediction of metabolic alterations". Cite using: https://www.biorxiv.org/content/10.1101/2024.01.15.575710v1 +Note: We are still refining the tool. Particularly, GEMCAT does not yet provide guidance for significance of predicted changes or any other measure of prediction quallity. We suggest to filter the predictions for consistency. We do not recomment to prefilter the transcriptomics and proteomics data based on significance as this is affecting the network coverage which might negatively impact the prediction quallity as genes/proteins not present in the dataset are assumed to be unchanged. + ## Compatibility The package is tested for compatibility with Python >= 3.10 on Ubuntu and Windows. @@ -99,4 +101,4 @@ These slow running tests are integration tests with "real world data" and will t To run tests, make sure you have [git lfs](https://git-lfs.com/) installed and all the Tests are running. Make sure to run `isort` and `black` to have properly formatted code. -The CI pipeline in Github will check with isort, black, and pytest. \ No newline at end of file +The CI pipeline in Github will check with isort, black, and pytest.