Skip to end of metadata
Go to start of metadata

 

When users first launch IGB, they see a start screen carousel with images representing species with genome assemblies that are supported in IGBQuickLoad.

When users click an image, IGB switches to the latest genome version for that species.

This document explains how you can add a new image to the IGB start screen.

Note that if there is no genome version available for the newly added species, the shortcut will fail. You should only add a new image to the start screen carousel if the genome is supported by one or more default servers.


Setting up

Fork the repository and clone a copy onto your local computer. See Developing IGB.

View examples of IGB start screen images in core/common/src/main/resources/images in your local copy.

Create start screen image

Find or create a non-copyrighted image to represent the species.  

The image should be:

  • PNG format
  • 250 pixels wide and 250 pixels tall
  • resolution 72 pixels per inch (DPI)

Add the image and image credits to the repository

The image file name must match the genome version, minus the date and year information. For example, the image representing the latest human genome version is named H_sapiens.png. Likewise, the image representing the japonica rice genome is named O_sativa_japonica.png.

To add the image file to the repository:

  • Add and commit the file to core/common/src/main/resources/images
  • Edit the file named image credits - record the source of the original image.

Add image and species to start screen configuration file

The start screen reads its data set configuration from a plain text file named display_species.txt, which resides in core/common/src/main/resources.

Enter the name of the new image in the file.

Note the carousel displays images in the order they appear in this file. When you add new images, make sure that the human genome image stays in the center of the start screen.

 

  • No labels