diff --git a/README.md b/README.md index b11a02b64..7d4cee267 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# PIMMS +![log](docs/logos/logo.png) [![Read the Docs](https://img.shields.io/readthedocs/pimms)](https://readthedocs.org/projects/pimms/) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/RasmussenLab/pimms/ci.yaml)](https://github.com/RasmussenLab/pimms/actions) [![Documentation Status](https://readthedocs.org/projects/pimms/badge/?version=latest)](https://pimms.readthedocs.io/en/latest/?badge=latest) - PIMMS stands for Proteomics Imputation Modeling Mass Spectrometry and is a hommage to our dear British friends who are missing as part of the EU for far too long already (Pimms is a British summer drink). -The publication is accepted in Nature Communications -and the pre-print is available [on biorxiv](https://doi.org/10.1101/2023.01.12.523792). +We published the [work](https://www.nature.com/articles/s41467-024-48711-5) in Nature Communications as open access: -> `PIMMS` was called `vaep` during development. -> Before entire refactoring has been completed the imported package will be `vaep`. +> Webel, H., Niu, L., Nielsen, A.B. et al. +> Imputation of label-free quantitative mass spectrometry-based proteomics data using self-supervised deep learning. +> Nat Commun 15, 5405 (2024). +> https://doi.org/10.1038/s41467-024-48711-5 We provide functionality as a python package, an excutable workflow or simply in notebooks. @@ -40,6 +40,9 @@ pip install pimms-learn Then you can use the models on a pandas DataFrame with missing values. You can try this in the tutorial on Colab by uploading your data: [![open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/RasmussenLab/pimms/blob/HEAD/project/04_1_train_pimms_models.ipynb) +> `PIMMS` was called `vaep` during development. +> Before entire refactoring has been completed the imported package will be `vaep`. + ## Notebooks as scripts using papermill If you want to run a model on your prepared data, you can run notebooks prefixed with diff --git a/docs/conf.py b/docs/conf.py index 490c5a639..0f4551115 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -89,6 +89,8 @@ # a list of builtin themes. html_theme = 'sphinx_book_theme' # pip install sphinx-book-theme +html_logo = 'logos/logo.png' +html_favicon = "logos/logo_thumbnail.png" # See: # https://github.com/executablebooks/MyST-NB/blob/master/docs/conf.py diff --git a/docs/index.rst b/docs/index.rst index e2b0caf15..31e097275 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ Welcome to proteomics imputation modelling mass spectrometry (PIMMS) documentation! -================================ +=================================================================================== .. https://github.com/sphinx-doc/sphinx/issues/7000#issuecomment-1006645012 .. https://stackoverflow.com/a/54519037 diff --git a/docs/logos/logo.png b/docs/logos/logo.png new file mode 100644 index 000000000..63fab1114 Binary files /dev/null and b/docs/logos/logo.png differ diff --git a/docs/logos/logo_thumbnail.png b/docs/logos/logo_thumbnail.png new file mode 100644 index 000000000..e6db195bf Binary files /dev/null and b/docs/logos/logo_thumbnail.png differ