Database QC table

Display a table with present and missing data in a database

Description

A table with present and missing data is built for the given data types. Data filters can be provided for each. Data are sorted according to the given keys.

This is a generic process, which can (should) be derived for some specific pipelines. See for instance Morphologist QC table in the Morphologist toolbox, or Freesurfer / BrainVISA QC table in the Freesurfer toolbox.

In the table, each present data can be clicked to display the data file name, and a double-click will trigger a viewer process (when available). In some cases multiple data will reside within a single table cell. In such a case, a menu will popup when clicking on it, and will allow to display the filename or view each of the data here.

Paramètres

database: Choice ( input )

Database to be displayed

data_types: ListOf( Choice ) ( input )

List of data types which should be displayed in the table. Data types are "exact" data types (inherited types are not displayed). It is possible to specify several times the same type, which can be useful when used with different filters (see the data_filters parameter).

data_filters: ListOf( String ) ( input )

For each data type to display, a selection filter can be specified. Each filter is given as a string for technical reasons, but the strings should contain python dictionaries code (JSON-like), for instance: {"acquisition": "timepoint_0"}.

The number of filters should normally match the number of data types. However if only one filter is present, it will apply to all data types (specify a second empty filter if you need to avoid this behaviour), and "missing" filters are empty otherwise.

keys: ListOf( String ) ( input )

Keys are used to sort and display data. One data line will be created for a single keys values combination.

type_labels: ListOf( String ) ( input )

Labels dispmlayed for each data type on the top header of the table. If not specified, use the data types names.

output_file: Text file ( optional, sortie )

Allows to save the QC table as a HTML file. If this parameter is filled, then the process will not open the Qt GUI and will run in batch mode.

PDF export is also possible, if the program wkhtmltopdf is installad on the system and available in the PATH.

Informations techniques

Toolbox : Gestion des données

Niveau d'utilisateur : 2

Identifiant : database_qc_table

Nom de fichier : brainvisa/toolboxes/data management/processes/database_qc_table.py

Supported file formats :

output_file :

HTML, HTML, PDF File