Skip to content


User guides for the OMERO R API

Binder Documentation Status Actions Status

The documentation is deployed at Use R API

This guide demonstrates how to use the OMERO R API.

To run the notebooks, you can either run on or build locally with repo2docker.

To build locally:

  • Install Docker if required
  • Create a virtual environment and install repo2docker from PyPI.
  • Clone this repository.
  • Run repo2docker
  • Depending on the permissions, you might have to run the command as an admin
pip install jupyter-repo2docker
git clone
cd omero-guide-r
repo2docker .

See also setup.rst

This is a Sphinx based documentation. If you are unfamiliar with Sphinx, we recommend that you first read Getting Started with Sphinx.