The MARTi GUI

The MARTi GUI is a browser-based interface for viewing and interacting with analyses. The GUI consists of four pages:

  1. Samples - for selecting and loading analysed samples into the Dashboard and Compare pages.

  2. Dashboard - for viewing analysis results of a single sample.

  3. Compare - for comparing the results from multiple samples.

  4. New analysis - for configuring and initiating local MARTi Engine analyses.

The Samples page

MARTi GUI samples page

The Samples page allows users to select and load available samples into the Dashboard and Compare analysis modes. A sample can be loaded into the Dashboard mode by clicking on its sample ID or the dashboard icon next to it. To compare samples, select them with the checkboxes in the first column of the table and then navigate to the Compare page.

The Dashboard page

MARTi GUI dashboard page

The Dashboard page is for viewing analysis results of an individual MARTi sample. This could be a single nanopore sequencing run or an individual barcoded sample within a run. The sample can be one that was previously analysed by the MARTi Engine, or one that is currently being analysed. In the latter event, the information on the page will update in real time when new analysis information is made available by the Engine.

The Dashboard content is flexible and dependent on the available analyses for the selected sample. When all available analyses are run for a sample, the page can feature up to 8 cards (content containers):

  1. Sample card – Displays information about the selected sample such as its ID, the analysis pipeline used, analysis status, and total number of basecalled reads.

  2. Taxa table card – A table of taxa with hits at the selected taxonomic rank and lowest common ancestor cut off value.

  3. Donut card – Interactive donut plot of classified reads at selected filter levels.

  4. Tree card – Customisable tree plot representing all of the analysed reads.

  5. Treemap card – An interactive treemap plot.

  6. Taxa accumulation card – Line chart showing taxa discovered over time, or reads analysed.

  7. AMR Table card – A table of antimicrobial-resistance (AMR) genes found in the sample.

  8. Walkout Analysis card – Donut plot showing results from AMR gene walkout analysis.

The Compare page

MARTi GUI compare page

The Compare page enables multiple samples to be explored together, including samples being analysed in real time.

This page features four cards:

  1. Samples card – Allows the user to sort the selected comparison samples by ID, sequencing date, yield, reads analysed, and by manually dragging them.

  2. Stacked bar card – A stacked bar chart for viewing the taxonomic composition of the selected samples side-by-side.

  3. Multi-donut card – A multi-donut plot for comparing the composition of assigned reads between samples.

  4. Taxa accumulation card – A multi-line chart representing taxa discovery rates of each sample over the course of analysis, with the x-axis showing either reads sampled or time analysed.

New analysis page

MARTi GUI new analysis page

The new analysis page allows users to generate a configuration file and start a local MARTi Engine analysis from the MARTi GUI.

The MARTi Engine requires a configuration (or ‘config’) file to start a new analysis of a whole run or selected barcoded samples. The config file provides the details for the analysis to be performed by the MARTi Engine (see here for config file format information). When running MARTi in an HPC configuration, a config file with default options can be generated via the command line and then edited with a text editor if required. In local configuration, you can use the command line method or the new analysis page of the MARTi GUI to generate a config file and start analysis.

The new analysis page is comprised of a single card that houses all the input fields and buttons required to generate a config file and start a new analysis. Two of the fields rely on information provided by the user in the marti_server_options.txt file:

  • MinKNOW run ID – this dropdown is automatically populated with samples available for MARTi analysis found within the MinKNOW run directory specified by the user.

  • MARTi output directory – a dropdown of paths being monitored by the GUI’s server for MARTi output. Users specify this path, or a colon-separated list of paths, as MARTiSampleDirectory in the server options file. The path selected in the dropdown will be used as the output location for the new analysis.

To start a new analysis from this page:

  1. Select a sample to analyse from the MinKNOW run ID dropdown.

  2. Choose an output directory using the MARTi output directory dropdown.

  3. If you’re analysing a barcoded run, tick the Process barcodes checkbox and then select the barcodes you wish to analyse in the newly revealed Select barcodes box.

  4. Under the Pipeline default settings subheading, there are buttons to load default settings for the two most common MARTi pipelines, BlastLCA and BlastLCA-CARD. To classify reads using BLAST and MARTi’s LCA algorithm, click BlastLCA. If you also want to identify AMR genes, click BlastLCA-CARD. The BlastLCA-CARD button assigns the same default settings as the BlastLCA button but adds an additional BLAST process to align reads to the CARD database.

  5. For the BLAST process card to be used for taxonomic classification, complete the path in the Database directory input so that it points to the directory that contains your blast database. Then, set the Database prefix to the name of the database used as the prefix for the database files. Finally, tick the Use this BLAST to classify checkbox.

  6. If you also have a BLAST process for CARD then you’ll need to update the Database directory input of that process so that it points to the location of the CARD database.

  7. Select the maximum number of concurrent jobs that can be run by the local scheduler using the Max jobs dropdown.

  8. Click the Start analysis button.

Options

MARTi GUI general options

The general options menu for the GUI can be accessed by clicking the cog icon in the top right-hand corner of the page. Alternative colour palettes for the GUI can be found in this menu.

The Dashboard and Compare pages have additional page-specific options bars fixed to the bottom of the header bar. On the Dashboard page, this houses three buttons:

  1. the Assignments button - for downloading MARTi’s taxonomic assignments in CSV format for downstream analysis.

  2. LCA minimum abundance cut-off selector – for displaying the sample’s taxonomic assignment data at one of four LCA minimum abundance cut-off values (0, 0.1, 1, or 2%).

  3. Taxonomic rank dropdown - allows users to view the plots at different taxonomic levels.

MARTi GUI plot options

Many of the plots also have plot-specific options that can be accessed via the three vertical dots menu icon in the top right-hand corner of the plot’s card.