wiki:doc/net.sf.basedb.meludi.usermanual_start

Version 4 (modified by olle, 4 years ago) (diff)

Added description of index page and its key components

MeLuDI 1.5.0 User Manual

1 Introduction

Welcome to MeLuDI, a BASE extension package with registration wizards for melanoma-lung cancer projects.

1.1 What's in this manual

This manual is intended to be helpful for the daily user of MeLuDI. Sections marked with an asterisk (*) are not absolutely essential to using the software, and can be skipped, if an answer to a specific question is desired. However, the reason for including these sections at all, is that they may add to the total understanding of the context in which MeLuDI works and was developed.

1.2 *Background (for history buffs)

1.2.1 BASE

BASE was developed as a free web-based database LIMS solution for tracking of information and data generated in sequencing and microarray experiments from sample to analysis.

1.2.2 Reggie

BASE extension package Reggie was developed as an interface to BASE, tailored to the laboratory workflow for the SCAN-B breast cancer project (more accurately, to the part known as SCAN-B Primary). Reggie both simplifies entry of LIMS data into BASE, as well as inspection of the data and production of documents such as dilution protocols and results reports. At the time of writing, Reggie provides help with management of the complete pipeline from incoming samples, through extraction, library preparation, pooling for sequencing, secondary analysis of the NGS sequencing output, report generation and digital distribution.

1.2.3 MeLuDI mid-2014 - mid-2016

MeLuDI was later developed as another BASE extension, based on Reggie, but intended for melanoma-lung cancer projects. It was named "MeLuDI" after the original project it was developed for, which got its name from "melanoma/lung cancer diagnostics". (When the name "MeLuDI" is used in this document without further specification, the reference is to the software.) MeLuDI was developed continuously until version 1.4.3, when the original MeLuDI project was terminated. The software then covered a workflow from sample registration to library preparation.

1.2.4 MeLuDI fall-2016 -

During fall 2016, a number of research projects at Lund University involved lab work using a workflow very close to the one used for the original MeLuDI project, so it was decided that a modified version of the MeLuDI software was to be used to track samples. MeLuDI was updated to support use in several BASE projects, allowing different items to have project-specific prefixes and number of digits in names, as well as project-specific default values for a number of items. Created documents like dilution protocols and statistics reports were updated to include the name of the active project. Together with other updates intended to support more flexibility in the workflow, the updated software was released as MeLuDI v1.5.0.

1.3 *Motivation for use

1.3.1 Why use a database to store LIMS info in?

The excellent search abilities of a database, especially a relational database, is normally enough to justify its use.

1.3.2 Why use BASE?

If you work with a genomics project, BASE provides a convenient interface to the underlying database:

  1. Listings of items like samples, extracts, bioplates, etc. can be easily selected from menus, and filters and sorting rules can be entered in a simple way.
  2. BASE is built with a knowledge of the relationship between the different items, e.g. an extract item can be created from the page describing the parent sample/extract, and the created extract will automatically be linked to the parent item, and the new child item will appear on the page for the latter.
  3. BASE contains tools to simplify import/export of data in batch-mode, e.g. batch import can be made from definitions in a text file with tabular data in tab-separated columns.
  4. Project and user management. BASE allows data to be coupled to a project item, and the system normally only shows items for that project, but items can also be shared to several projects. User administration is also included, where a user can be given different sets of permissions in different projects.
  5. Support for two-factor authentication for increased security.
  6. Web-based interface. When BASE was first conceived, not all database management systems had web-based interfaces.

The decision whether to use BASE or not, often depends on the prevalent digital infra-structure for the laboratory. Much of the work in creating a new BASE installation is related to setting up the server and installing the database, that BASE will use. If a BASE installation already is present in the laboratory, much is simplified. However, the final decision may also depend on other conditions, e.g. requirements to use another LIMS system by regulations or policy decisions.

1.3.3 Why use MeLuDI?

Although genomics data can be entered directly in BASE, if you are working in a project with a workflow similar to that covered by MeLuDI, its use will simplify several things:

  1. Creation of multiple extract items from the same parent sample/extract item in BASE requires performing the same operation repeated times. MeLuDI allows all necessary data to be entered in a wizard, after which it creates the new items with needed database links and attached information.
  2. MeLuDI provides support for naming conventions for different items in a project, something BASE is ignorant of. Specific prefixes and number of digits in serial numbers may be chosen for items such as samples, item lists, storage boxes, library plates, patient items, and library preparation kits. This is also supported by the system proposing serial numbers in names for new items, as well as storage box positions.
  3. MeLuDI uses a suffix system for names of child items inherited from Reggie, where specimens have a dot plus a number added to the case name, DNA extracts have ".d" added to the parent name, FPA aliquots have ".fpa" added to the parent DNA name, etc. This allows the parent heritage items to be identified for an extract directly from the name.
  4. Support exists for creating input configuration files with selected sample names for various instruments, as well as importing measurement values from text files generated by the instruments. Files can also be created for label printers.
  5. MeLuDI allows creation of dilution protocols, plate layouts, and statistical reports in formats, that are suited both for inspection on a screen and for print-outs.
  6. Information related to the same case can be conveniently displayed in a summary page, with links to the individual BASE items, for further inspection in BASE.

2 General interface structure

MeLuDI inherited a general interface structure from Reggie. The interface was created with the intention of making access to central functionality as simple as possible.

2.1 Start (index) page and some key components

MeLuDI index page SMIL 01 with key elements numbered 80 percent

  1. BASE main menu (Note! Not to be confused with the web browser menu at the top).
  2. BASE project menu (the image shows project "SMIL" as active project).
  3. BASE Extensions menu. This is the menu where extension "MeLuDI" is selected.
  4. Name of active project (here: "SMIL").
  5. BASE extension name; also works as quick link to the start (index) page, i.e. the shown page.
  6. Link to a MeLuDI web page, e.g. a wizard.
  7. A counter, showing the number of items in queue (optionally) for a wizard.

2.1.1 User permissions and shown sections on the start (index) page

The example start page above shows five sections:

  1. Sample processing wizards
  2. Library preparation wizards
  3. Server administrator wizards
  4. Personal information wizards
  5. Statistics and reporting wizards

The number of shown sections on the start page depends on the permissions of the logged-in user, as only sections the user is allowed to use are shown. The example above shows all sections, as the logged-in user is root, i.e. system administrator. The "Server administrator wizards" section is only visible for a system administrator, and the "Personal information wizards" section is only visible for a system administrator and users belonging to the PatientCurator group.

2.2 Wizard page key elements

Below is a description of some of the key elements, that are components of most of the wizards.

2.2.2 User permissions and wizards and results pages

Attachments (29)

Download all attachments as: .zip