Reporting

Introduction

Phaedra can generate reports from your data, allowing you to obtain a high-level overview of the data in a clean and presentation-oriented format.

Reports are generated in the PDF file format, and can work in two ways:

  • Template reports are generated from predefined templates which already contain layout and formatting information.
  • Ad-hoc reports are generated from scratch, by adding views to a blank page and arranging the layout manually.

Any user can generate a report (provided they have read access to the data being added to the report), but only administrators can create new report templates.

Installation

To install the Reporting addon, select Help > Install New Software. In the site list, select Phaedra Updates. Check the Reporting item in the addon list, and click Next.

Template Reports

Template reports are based on a template, and can be generated by selecting an experiment and running the Report Wizard. To do this, right-click on an experiment and select Create Report.

reporting.png

The Report Wizard will open, asking you to select one of the available templates.

reporting2.png

Click Next to proceed.

reporting3.png

In this screen, you can select the features which should be included in the report.

Many report templates contain feature-specific pages, such as charts. If you select multiple features, those pages will be repeated for each selected feature. Report templates that do not contain feature-specific pages, will not show this screen.

Click Finish to create the report. When the report is ready, it will appear in a PDF Viewer:

reporting13.png

Use the Save button to save the PDF to your computer, or the Print button to print it out.

Ad-hoc Reports

In contrast to template reports, ad-hoc reports do not use a predefined template. You start with a blank report and fill it up by adding Phaedra views onto the report.

To start creating an ad-hoc report, select the menu Window > Show View > Other... > Reporting > Report Designer.

reporting4.png

In the Report Designer view, select the protocol you would like to create a report for, then click the New Report button.

reporting5.png

In the dialog that appears, enter a unique name for the new report, and click Ok. This will create a new, blank report, ready to be filled out by adding views into it.

To add a view, open it like you would open a view normally. For example, to open a Quick Heatmap view, right-click on a plate and select Show Quick Heatmap.

reporting6.png

Configure the view exactly like how you want it to appear in the report. When you are ready, click on the Reporting button and select Save view.

reporting8.png

Enter a unique name for the view and click Ok. By saving the view, you have created a 'snapshot' of the view's configuration. You can add this to the report by clicking on the Reporting button again, and selecting Add to report.

reporting7.png

In the dialog that appears, select the report you just created, and click Ok.

The view will be added as a new page to the blank report. You will be asked to enter a title for the page, as well as an optional description which will be printed below the view in the report.

reporting9.png

If you look at the Report Designer view again, note that the view has been added to the list of views for the new report.

reporting10.png

You can continue adding views to the report in this fashion. Note that the report design is saved automatically every time you add, remove or modify a view. When the report design is finished, you can generate the report by clicking on the Print Report button.

reporting11.png

The report will be generated according to your design. When it is ready, the PDF will open in a separate view.

reporting12.png

To save the report, click on the Save button in the top left of the PDF view.