Skip to content
This repository has been archived by the owner on Aug 24, 2021. It is now read-only.

Functionality

sebastian-raubach edited this page May 16, 2018 · 2 revisions

Functionality

We are now going to highlight some of the most important features of Germinate. All features shown in this section are applicable across various data types and pages.

User interface language

Germinate fully supports internationalization. This means that the interface can be translated into any number of languages. By default, Germinate is distributed in English. Depending on the configuration of Germinate, other languages may be available. You can switch between them by selecting a language from the first dropdown box shown in Figure C.

Menu

Germinate's main menu (see Figure A) is positioned along the left of the web interface on desktops, although it may collapse into an expandable menu along the top on smaller devices. Clicking on a submenu will expand the corresponding category whereas selecting a menu item will navigate to that page.

Please note, that depending on the configuration of the Germinate instance you are using, the menu might have a different structure.

Data filtering

A lot of tables you encounter in Germinate support filtering based on columns. These tables will have a filter icon in the top-left corner which, when clicked on, opens the table column filters.

The filter interface can be seen in the figure above. Each row represents a restriction. It consists of a table column, a comparison operator and, depending on this operator, either one or two values. Multiple rows are combined with boolean combinations. By default the individual filters are combined with a boolean "And", meaning that all of them have to be true at the same time. You can switch this to a boolean "Or" to get results where at least one of the individual filters is fulfilled. Once this filter is applied, the table will only show items that match the given overall filter query.

This is a particularly useful feature if you want to find items that, e.g., are from a specific country, or that have a phenotype value within a certain range. The resulting items can then be marked or put into a group.

Search

Germinate supports full-text search across various data types and columns within this type. You can search by typing a search query into the text box shown in Figure B. Upon search, Germinate shows the search results page. This page shows all matching database objects grouped into categories, each category representing a different data type. The figure above shows an example of the search results that Germinate provides. The number of matching items is shown for each section on the right. Upon expanding of a section, a result table will show the matching database items. You can then either download the data, mark specific items or filter down further by adjusting the search criteria in the table filter.

Groups

In Germinate we define the concept of a group to be an arbitrary grouping of database items of a certain type. Germinate supports groups of accessions, markers and locations. These groups can be pre-created by an administrator or user-defined, which means that you can create your own groups (assuming user authentication is enabled).

The purpose of these groups becomes clear once you start exporting data. All types of data can either be exported for the whole dataset or the data can be subset into smaller chunks by selecting a single or a selection of groups. The exported data will then contain information about the selected groups only.

An example of this is shown in the figure above where we selected a group of accessions (192 out of 2000 accessions) and a group containing a single marker (out of 5000). The resulting data file will consequently contain at most 192 rows and at most a single column of data (it may contain less, if the selected database items are not actually part of the selected dataset).

Creating a group

This section is only applicable if the Germinate instance you are using has user authentication enabled.

In addition to using the predefined groups, you can create new groups of your own. There are multiple ways in which you can create a new group and add items to it. One option is to go to the Groups page of Germinate. This page shows you all the existing groups in a table and upon selection, shows you its group members.

The figure above shows you an example of what the groups page can look like. In this example, Germinate contains 118 different groups that the current user can see. New groups can be added and existing ones deleted by pressing the buttons below the groups table (Figure A). Deleting a group requires you to select the checkbox in the corresponding table row as well as to have sufficient permissions to do so. When creating a new group you will be asked to select the group type and to decide on a name for the group. When you do so, the group will be associated with your user account.

Once this is done, the group will be created and Germinate will automatically select it and show the group members table (empty at this point) below the groups table. You can now manipulate the group itself by adding and removing members using the buttons below the table as shown in Figure C.

Adding members to an existing group can be achieved in two ways. You can upload a list of those items from a text file or your clipboard and Germinate will look these items up based on their identifier. Once found they will be added to the group. The other option is to use a boolean search feature that is similar to the way the table filtering works. You can choose fields from the database tables and specify values that the items in questions should equal, smaller or larger to. The figures above show what the group member search interface looks like. The query is specified in the first figure and the result shown in the second figure.

Groups can be made public so that other users have the option to use them as well. If you decide to make your group public, toggle the switch button shown in Figure B (Groups page).

Marked item lists

Another useful feature of Germinate is the concept of marked item lists. A marked item is either an accession, a marker or a location that is of interest to the user. While you are browsing the page, a lot of the tables will have a checkbox column as the last column which you can use to mark certain items. Germinate will keep track of these items for you.

To see how many items you currently have marked, you can click on the menu item as shown in the first figure above or go directly to the marked item lists page that is shown in the second figure. Once you have marked all the items that you are interested in, you can create a group of these items and use them to export data against them. To create a group, you can either go to the marked item lists page or by clicking on the header of the checkbox column and selecting "Create group from selection" (see third figure).

Charts

Most of the charts we use in Germinate are custom-built for this interface and therefore closely integrate with the way Germinate operates. All charts will offer some kind of interactivity. This can range from simple tooltips to the ability to select data points with a lasso. All charts can be downloaded as a Portable Network Graphics (PNG) or a Scalable Vector Graphics (SVG) file. Additionally, the underlying data for each chart can be downloaded in a tab-delimited data file. If the selection of individual data points is enabled, the selected items can be added to or removed from the marked item list.

Help

Whenever you are stuck and are not sure what to do or how to use the web interface, you can click on the last item in Figure C (Overview, Home). This will open a popup with information about the page you are looking at. Sometimes this information may provide links to external resources or external tools, other times it will just explain certain parts of the page in more details.

Please note that help information may not be available for all pages. In those cases, the menu item will be disabled. We are trying to make the user interface as intuitive as possible and are working towards adding help information to all the pages. If at any point you have questions about Germinate in general or specific features of the web interface, please do not hesitate to contact us on: germinate@hutton.ac.uk.