Introduction

What is Djerba?

Djerba is a system for generating clinical report documents from pipeline data, with a modular structure based on plugins. It is named after a Mediterranean island and pronounced “jerba” (the initial letter D is silent).

What Does Djerba Do?

Djerba inputs a config file and outputs a report.

The config file is in the widely-used INI format.

The report contains equivalent information in three different formats: JSON, HTML, and PDF.

  • JSON is a machine-readable format for the report data.

  • HTML is used for typesetting, to specify the report appearance.

  • PDF is shared with clinical practicioners.

How To Use This Documentation

The How Djerba Works section briefly covers key concepts and terminology. We recommend it as a starting point for all Djerba users.

The User Guide describes how to install Djerba, and run existing plugins to produce reports.

The Component Reference has detailed descriptions of plugins and other components of Djerba, used for clinical reporting at OICR.

We encourage users to write their own plugins, as described in the Developer Guide.

Finally, the Contact section has contact links for the Djerba developers, and some brief notes on development policy.