heightFXMATE Documentation

1 General

1.1 What is FXMATE?

FXMATE (pronounced “effects mate”) is a modern app for analyzing biotests in the context of environmental risk assessment. It is built on the MATE principle (MAde Totally Easy). The user is progressively lead through the application. With appropriately suggested models/tests and easy interpretation boxes, FXMATE ensures guardrails for non-statisticians while still offering access to the full repertory of methods. The primary goal of FXMATE is to be easy to use, guideline-conform, statistically correct and reproducible. Among others, this is achieved with R, Shiny and Docker.

1.2 Design principles

The design of the app consists of four major components:

  1. Sidebar

The sidebar is the component where all user inputs are located. From file upload, to selection, sliders or text input. It is the only place in the user interface (UI) that controls the output of the analyses and methodological choices.

  1. Main Panel

The main panel mainly displays relevant information and results to the user. Only occasionally checkbox inputs to confirm or buttons to download results are located in the main panel.

  1. Primary Navigation Bar

The primary navigation bar is used to navigate through the main modules of the app. These are Data, Model, Other ECX, Statistics and Report. They progressively appear if requirements of the proceeding modules are met (and they are selected). In certain events (e.g., when a new data set is loaded) these panels also disappear to start the analysis anew.

  1. Secondary Navigation Bar

The secondary navigation bar is used to navigate the subsections of each main section. Just like the primary navigation bar the panels appear progressively. The secondary navigation bar also holds the “Proceed” button to continue to the next main section.

1.3 Requirements

FXMATE has been tested on Safari, Chrome, and Firefox. Since FXMATE is built on the widely used Bootstrap 5 framework, also other browsers are expected to be compatible. The app runs on a server-side Docker image. This has the benefit of giving the same results no matter on which device the app is run but also that nearly no hardware requirements are necessary. However, it is strongly recommended to use a screen resolution of at least 800x1400px. Since FXMATE runs in your browser you can use all available accessibility features (e.g., using zoom to increase/decrease the size of the UI).