Skip to content

Latest commit

 

History

History
118 lines (75 loc) · 5.37 KB

README.md

File metadata and controls

118 lines (75 loc) · 5.37 KB

Online version: OmicLearn

📰 Documentation: OmicLearn ReadTheDocs

📄 Manuscript: Open-access Article

OmicLearn Test OmicLearn Python Badges OmicLearn Version OmicLearn Release OmicLearn License

OmicLearn

Transparent exploration of machine learning for biomarker discovery from proteomics and omics data.

This is a maintained fork from OmicEra. Note: The original repository has been deleted.

Quickstart

A three-minute quickstart video to showcase OmicLearn can be found on YouTube.

PyCon Talk

Manuscript


Citation:

Torun, F. M., Virreira Winter, S., Doll, S., Riese, F. M., Vorobyev, A., Mueller-Reif, J. B., Geyer, P. E., & Strauss, M. T. (2022). 
Transparent Exploration of Machine Learning for Biomarker Discovery from Proteomics and Omics Data.
Journal of Proteome Research. https://doi.org/10.1021/acs.jproteome.2c00473

Online Access

🟢 OmicLearn v1.4 | Online Access

This is an online version hosted by streamlit using free cloud resources, which might have limited performance. Use the local installation to run OmicLearn on your own hardware.

Local Installation

One-click Installation

You can use the one-click installer to install OmicLearn as an application locally. Click on one of the links below to download the latest release for:

For detailed installation instructions of the one-click installers refer to the documentation.

Python Installation

  • It is strongly recommended to install OmicLearn in its own environment using Anaconda or Miniconda.

    1. Redirect to the folder of choice and clone the repository:
    git clone https://github.com/MannLabs/OmicLearn
    1. Create a new environment for OmicLearn:
    conda create --name OmicLearn python=3.10 -y
    1. Activate the environment:
    conda activate OmicLearn
    1. Change to the OmicLearn directory and install OmicLearn:
    cd OmicLearn
    pip install .
  • After a successful installation, type the following command to run OmicLearn:

    python -m omiclearn
  • After starting the Streamlit server, the OmicLearn page should be automatically opened in your browser Default link: http://localhost:8501

Getting Started with OmicLearn

The following image displays the main steps of OmicLearn:

OmicLearn Workflow

Detailed instructions on how to get started with OmicLearn can be found here.

Contributing

All contributions are welcome. 👍

📰 To get started, please check out our CONTRIBUTING guidelines.

When contributing to OmicLearn, please open a new issue to report the bug or discuss the changes you plan before sending a PR (pull request).

We appreciate community contributions to the repository.