Skip to content

ili-toolbox/ili-toolbox.github.io

Repository files navigation

`ili

`ili is a toolbox for 2D and 3D molecular mapping.

`ili is being developed mainly by Alexandrov Team at EMBL Heidelberg (contact information) in collaboration with the Dorrestein Lab and the Knight Lab at UCSD.

  • Developers: Ivan Protsyuk, Sergey Ryazanov
  • External contributors:
    • Members of Knight lab: Antonio Gonzalez, Jamie Morton, Jose Navas, Yoshiki Vázquez Baeza
  • Principal investigator: Theodore Alexandrov

Hello bee

For a demonstration, open

       Screenshot of the human example

  • 3D bee example (data provided by Yi Zeng from the Dorrestein Lab, UCSD)

       Screenshot of the bee example

       Screenshot of the 3dmassomics example

Examples from real-life studies

On this page you can find examples of `ili being applied in research.

Installation

The best ways of running `ili are either from this website or as a Chrome extension.

Input

`ili takes two files:

  • for 2D mapping: a PNG or JPG file to be used as the background image (example), and a mapping file with intensities and coordinates in CSV format (example)
  • for 3D mapping: a 3D model in STL format (example), and a mapping file with intensities and coordinates in CSV format (example)

To create a mapping file suitable for input, you need two pieces of information: coordinates of your samples on your picture/model and intensities of features you're going to visualize in `ili. Please find the instruction on how to create a CSV table with coordinates here. Rows of the result table correspond to samples. Once you have it, you can add your features as new columns. Finally, you need to save it as a CSV file, and it is ready to be viewed in `ili. Refer to the examples above to have an idea of the final look of the table.

Cartographical snapshots

`ili facilitates reproducible data analysis by providing the feature of cartographical snapshots: a complete copy of all visualization settings saved to a file. The file can be reused later or shared with other users, who, afterwards, will be able not only to recover the same view, but also use it as a starting point for further analysis.

The cartographical snapshot is a file in JSON format that can be opened in `ili using drag&drop along with corresponding files of 3D model/image and spatial mapping.

Demo

You can find a list of ready-made examples in the "Examples" tab in the `ili sidebar. Click on any of them, and necessary files will be loaded to the app automatically.

How to use it?

One of the fundamental ideas behind the `ili interface is the simplicity of usage. Therefore, most operations can be performed with keyboard shortcuts.

Action Shortcut on Windows, Linux Shortcut on OS X Alternative
Open files Ctrl+O +O Drag and drop files to `ili window. Also, when you just launched `ili, you can press Open button at the center of the window.
Switch between molecular maps Ctrl+, Ctrl+ + , + Click on a name of an active map above a colorbar at the right-bottom corner of an app window and select another map with mouse.
Find a molecular map by its name Ctrl+F +F Click on a name of an active map above a colorbar at the right-bottom corner of an app window and start typing.
Save view as image Ctrl+S +S NA
Save cartographical snapshot Ctrl+E +E NA

Many other controls for adjusting visualization are available in the `ili sidebar. Three main sections there "2D", "3D" and "Mapping" correspond to settings affecting 2D/3D views and colormaps.

Mouse buttons can be used to adjust point of view on a model/picture.

Action Mouse button Views where available
Rotate model Move mouse holding its left button 3D
Move image Move mouse holding its left button 2D
Zoom Rotate mouse wheel 2D, 3D
Display spot name Click at a spot with left button 2D, 3D
Move model Move mouse holding its right button 3D
Enable/disable model auto-rotation Double-click 3D

Any questions?

Feel free to leave your questions and suggestions as issues in this repository or at the "Support" section on the `ili page at Google web store.

How to stay updated

Please sign up to the mailing list by sending an email to [email protected]

Miscellaneous

  • Why is it called `ili? `ili in Hawaiian means skin and, among others, surface, area, or cover.
  • How to record videos or screencasts in `ili? Please use a third-party software, for example ScreenCastify plugin to Chrome
  • How can I cite `ili in my scientific publication? We haven't published a paper devoted to `ili yet, so please cite Bouslimani et al. (2015) PNAS, our publication which motivated us the create and release `ili.

License

The content of this project is licensed under the Apache 2.0 licence, see LICENSE.md.

Funding

This project is funded from the European projects 3D-MASSOMICS (FP7 HEALTH program, grant agreement no. 305259), METASPACE (Horizon2020 program, grant agreement no. 634402) and from the internal funds of European Molecular Biology Laboratory.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published