README.md 2.04 KB
Newer Older
1
## Image Data Explorer
Kimberly Isobel Meechan's avatar
Kimberly Isobel Meechan committed
2

3
Most bioimaging projects derive data from images and regions of interest (ROIs, e.g. segmented objects) on those images. It is desirable, and sometimes necessary, to explore these image-derived data while visualizing the image(s) and ROIs associated with each data point. To address this need, we developed the Image Data Explorer (IDE). The IDE is implemented as a Shiny app (i.e. a web app written in R using the Shiny package).
Kimberly Isobel Meechan's avatar
Kimberly Isobel Meechan committed
4

5
### Quick start
6
7
8
9
Before you start, make sure that your data conforms to the requirements described in the [wiki section on preparing data for use with the IDE](https://git.embl.de/heriche/image-data-explorer/-/wikis/Preparing-the-data-for-use-with-the-IDE).  


Don't want to install anything? Try our [ready-to-use cloud-based instance](https://shiny-portal.embl.de/shinyapps/app/01_image-data-explorer).  
10

Jean-Karim Heriche's avatar
Jean-Karim Heriche committed
11
12
Check our [2 min video introduction](videos/intro.mp4).  

Jean-Karim Heriche's avatar
Jean-Karim Heriche committed
13
The IDE needs a computer with an [R environment version >=3.5.0](https://www.r-project.org/). The IDE requires some R packages and will try to install them if it can't detect them on the system. For more details, check the [wiki section on installation](https://git.embl.de/heriche/image-data-explorer/-/wikis/Installation).
14

15
Download the code from the project's repository and run it from within the project directory:
16
```
17
18
19
git clone git@git.embl.de:heriche/image-data-explorer.git
cd image-data-explorer
R -e 'shiny::runApp("image_data_explorer.R", host = "0.0.0.0", port = 5476)'
20
21
```
The app is then accessible from a web browser at http://127.0.0.1:5476  
22
Alternatively, open the file image_data_explorer.R with [RStudio](https://www.rstudio.com/products/rstudio/download/) then click the 'Run App' button.
23

Jean-Karim Heriche's avatar
Jean-Karim Heriche committed
24
The app can also be [run in a container](https://git.embl.de/heriche/image-data-explorer/-/wikis/Installation#building-and-running-the-app-in-a-container).
25

Jean-Karim Heriche's avatar
Jean-Karim Heriche committed
26
More details can be found in the [wiki](https://git.embl.de/heriche/image-data-explorer/-/wikis/home#-user-manual).
27
28
29


### Screenshot
30

31
<img src="screenshots/image_data_explorer_v1.1.screenshot.png"/>
32