Structure of a MINERVA project#
MINERVA projects can include multiple files, allowing to pre-configure a number options and functionalities. The structure explained below can be either compressed into a .zip file or uploaded from a git repository. See this repository for example.
The list of project components is as follows:
- root diagram (file, mandatory)
a systems biology diagram in one of the compatible formats: CellDesigner SBML, SBML, SBGN-ML, or GPML, see compatible formats. - submaps (folder, optional) - see Submaps
- any number of compatible systems biology diagrams (file(s))
- overlays (folder, optional) - see Overlays
files with data overlays to be set as publicly visible for the project, see more in visualisation - glyphs (folder, optional): directory with glyphs (see Glyphs)
- images (folder, optional): directory with files displayed as Browse overview images (see Overview images)
- config.json (file, optional): configuration loaded on project creation to
- .minervaignore (file, optional): lists files and directories to exclude when the project is created. This is useful for projects built from a git repository, or from an archive created on a system that adds its own metadata files. The syntax of the file is similar to
.gitignore.
Learn more about advanced upload in example 4 - The advanced file upload.
Learn more about config.json in config file structure.
Sections of the structured project#
Submaps#
The submaps subdirectory contains files that will be displayed in the Submaps tab in the functional area of the User view (see section User view - Submaps tab).
Diagram elements can be configured to act as links (anchors) to other diagrams. Any element from the root or a submap diagram can be connected to any other diagram. To set up these links, use the dedicated Edit functionality (see Projects > Customise exploration).
Note If you’d like to preserve the manually introduced submap connectivity, use Download current project files from the Project info tab - the downloaded .zip file will contain the config.json with the existing mapping of elements and submaps they are linked to.
Overlays#
The overlays subdirectory contains files with custom colouring of the uploaded content that will be accessible to all the users. The format is identical to the format of files uploaded by registered users. See section Upload user provided overlay data for details on file format.
Overview images#
The images subdirectory contains static image files in .png format that will be displayed after pressing the Show overview button (see Browse overview images in User manual).
The links between the images and i) other images or ii) the contents of the map have to be expressed in config.json file (see here). The overview_images key holds an array of entries, one per image, each containing the following keys:
- filename (string): linked image file.
- width and height of the image
- links: an array with the following elements
link_type (MAP|OVERVIEW_IMAGE|SEARCH_QUERY) describing what content will be linked to the image in filename
- MAP - display one of the maps (main or submap)
- OVERVIEW_IMAGE - display another overview image
- SEARCH_QUERY - display results of a search query
polygon: an array with the coordinates of the points defining the polygon which will be treated as an active area for the link. The points are defined as a set x/y absolute coordinates (double) of the pixels in the corresponding image.
target_map_filename (string): link type specific; name of a map (main or submap) for the MAP link type.
target_map_x/y/z (numeric): link type specific; focus point (x,y) and zoom level (z) for the map in the MAP link type. To get correct x/y/z coordinates, upload a draft version of the map and browse it in MINERVA - when you are at the correct location at correct zoom levels, copy x/y/z coordinates from the URL. Be aware that the same set of parameters may give different behaviour for different screens.
target_overview_image_filename (string): link type specific; name to the target overview image file for the OVERVIEW_IMAGE link type.
search_query (string): link type specific; the query to be executed for the SEARCH_QUERY link type.
Note Link type specific parameters not matching the link_type (e.g. target_map_filename for SEARCH_QUERY) will be ignored.
coords.json in older archives will still be accepted on upload.
Glyphs#
Glyphs are custom images that can be added to diagrams visualised in the MINERVA Platform, see Projects > Element glyphs. The image of any element of the diagram (species, compartment, pathways) can be replaced with such custom images.
Size and format Glyphs will be resized to fit the size and aspect ratio of the element they are assigned to.
MINERVA supports only .png images as glyphs.
Glyphs provided via this directory become automatically available for selection via a dropdown menu, without the need of their upload. They can be automatically assigned to specific elements on upload using config.json file.
Find more details about glyphs in the example 5 - Map with glyphs.
Note
If you’d like to preserve manual glyph assignment, use Download current project files from the Project info tab - the downloaded .zip file will contain the glyphs subdirectory with originally and externally uploaded files, and config.json with introduced mapping of elements to selected glyphs.
Alias vs identifier in CellDesigner files#
CellDesigner has a single species identifier for all copies of a certain element (e.g. SNCA protein) in a file.
If you open your CellDesigner file in any text editor you can find it in species tag, parameter id:
<species metaid="s1" id="s1" name="SNCA" compartment="default">
Different instances of the same element (here: ‘s1’) have different species aliases, so they can be distinguished in the model, e.g. two copies of SNCA protein in different reactions
You can find species alias of element if you open your CellDesigner file in any text editor, then find tag speciesAlias for particular species id (here: ‘s1’):
<celldesigner:speciesAlias id="sa1" species="s1">
<celldesigner:speciesAlias id="sa2" species="s1">
Aliases are the basis of assigning submap links and glyphs in MINERVA, see config file structure. If you have trouble locating species aliases in CellDesigner files, assign glyphs and submap links manually and use Download current project files from the Project info tab - the downloaded .zip file will contain necessary mappings in the config.json file.
Note
If you’d like to preserve manual submap assignment, use Download current project files from the Project info tab - the downloaded .zip file will contain the config.json with introduced mapping of elements to selected submaps.