https://github.com/ome/omero-guide-r

https://github.com/ome/omero-guide-r

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ome/omero-guide-r
• Owner: ome
• License: bsd-2-clause
• Created: 2019-08-23T09:40:30.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-10T12:15:33.000Z (about 3 years ago)
• Last Synced: 2025-06-05T06:56:25.676Z (about 1 year ago)
• Language: Jupyter Notebook
• Size: 2.01 MB
• Stars: 1
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# User guides for the OMERO R API

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ome/omero-guide-r/master?filepath=notebooks)

[![Documentation Status](https://readthedocs.org/projects/omero-guide-r/badge/?version=latest)](https://omero-guides.readthedocs.io/en/latest/r/docs/index.html)

[![Actions Status](https://github.com/ome/omero-guide-r/workflows/repo2docker/badge.svg)](https://github.com/ome/omero-guide-r/actions)

The documentation is deployed at [Use R API](https://omero-guides.readthedocs.io/en/latest/r/docs/index.html)

This guide demonstrates how to use the OMERO R API.

To run the notebooks, you can either [run on mybinder.org](https://mybinder.org/v2/gh/ome/omero-guide-r/master?filepath=notebooks) or build locally with [repo2docker](https://repo2docker.readthedocs.io/).

To build locally:

 * Install [Docker](https://www.docker.com/) 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 https://github.com/ome/omero-guide-r.git

cd omero-guide-r

repo2docker .

```

See also [setup.rst](https://github.com/ome/omero-guide-r/blob/master/docs/setup.rst)

This is a Sphinx based documentation. 

If you are unfamiliar with Sphinx, we recommend that you first read 

[Getting Started with Sphinx](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html).