Skip to content

Commit 0372da5

Browse files
Update README.md
1 parent 662f975 commit 0372da5

File tree

1 file changed

+30
-12
lines changed

1 file changed

+30
-12
lines changed

README.md

+30-12
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,15 @@ The plugin can be used with:
5353
- `Open with` `->` `Vitessce` on the left side panel.
5454

5555
#### Right-hand-side panel:
56-
- **Prexisting config files**:
57-
![Link-List-image](https://github.com/user-attachments/assets/b95c77a3-77c5-4221-83f2-c9c460a83f2e)
58-
Clicking the link will open a new tab with the viewer displaying the selected configuration.
59-
60-
- **Autogenerating config file**:
61-
![Form-image](https://github.com/user-attachments/assets/5c81aba3-adfd-465c-86f0-9e03506ec3ea)
62-
The form allows the user to automatically generate a config file with the selected parameters. After clicking the `Generate Config` button
63-
a config file is generated and attached to the dataset/image. The viewer displaying the autogenerated configuration will open in a new tab.
56+
- **Prexisting config files**:
57+
Clicking the link will open a new tab with the viewer displaying the selected configuration.
58+
![Link-List-image](https://github.com/user-attachments/assets/b95c77a3-77c5-4221-83f2-c9c460a83f2e)
59+
60+
61+
- **Autogenerating config file**:
62+
The form allows the user to automatically generate a config file with the selected parameters. After clicking the `Generate Config` button
63+
a config file is generated and attached to the dataset/image. The viewer displaying the autogenerated configuration will open in a new tab.
64+
![Form-image](https://github.com/user-attachments/assets/5c81aba3-adfd-465c-86f0-9e03506ec3ea)
6465

6566
#### Open-with:
6667
Right click on a `dataset` or an `images` in the left-panel and select `open-with` -> `Vitessce`.
@@ -74,7 +75,7 @@ After autogenerating or selecting a config file, the Vitessce viewer is opened i
7475

7576

7677
### Config files
77-
The omero-vitessce plugin considers all files with the `.json.txt` extension attached to the image or dataset as config files for the viewer.
78+
The omero-vitessce plugin considers all files with the `.json` extension attached to the image or dataset as config files for the viewer.
7879
The config files should follow the vitessce view-config-json format: http://vitessce.io/docs/view-config-json/
7980

8081
#### Autogenerated config files
@@ -84,12 +85,29 @@ Config files can be autogenerated for:
8485

8586
Assumes that the images are in the OME-NGFF format v0.4 and that [omero-web-zarr](https://github.com/ome/omero-web-zarr) is
8687
available to serve the images.
88+
The attachements must be in `.csv` format and the column with the cell identifiers should be consistent across attachements.
89+
Only files attached to the dataset/image are available in the form.
90+
91+
The following fields are available:
92+
`Config file name` (required, "VitessceConfig-YYYY.MM.DD_HHMMSS.json"): Name of the config file to attach, a ".json" extension is added if missing.
93+
`Image` (required): OMERO Image to view, OME-NGFF images only.
94+
`Segmentation` (optional, `None`): Segmentation to overlay on the image, OME-NGFF images only.
95+
`Cell identities` (optional, `None`): `.csv` file with at least 2 columns: `Cell id column` and `Label column` defined in the 2 fileds below.
96+
`Cell id column` (optional, "cell_id"): Name of the `Cell id column` used in `Cell identities`, `Expression`, `Embeddings`.
97+
`Label column` (optional, "label"): Name of the `Label` used in `Cell identities`.
98+
`Expression` (optional, `None`): `.csv` file with the `Cell id column` all other columns are considered as expression values and should be numerical.
99+
`Embeddings` (optional, `None`): `.csv` file with the `Cell id column` and the `Embedding x` and `Embedding y` columns defined in the 2 fileds below.
100+
`Embedding x` (optional, "UMAP_1"): Name of the `Embedding x` used in `Embeddings`.
101+
`Embedding y` (optional, "UMAP_2"): Name of the `Embedding y` used in `Embeddings`.
102+
`Histograms` (required , `True`): Add 3 plots showing: The number of transcripts per cell, the number of cells in each set, gene expression in each set.
103+
`Heatmap` (required , `True`): Adds an heatmap.
104+
105+
The `Expression` and `Cell identities` files are required to show the histograms.
106+
The `Embeddings` file is necessary to show the cells in a scatterplot.
87107

88108
#### Custom config files
89-
Custom config files should have a `.json.txt` extension and added as attachements to a dataset or an image.
109+
Custom config files should have a `.json` extension and added as attachements to a dataset or an image.
90110
The configuration files does not need to refer to the dataset / image it is attached to and can refer to other images.
91-
92-
93111
[examples](http://vitessce.io/examples/)
94112

95113
#### Serving the images / data /metadata

0 commit comments

Comments
 (0)