Combine Reports

Combine Reports takes reports as input and summarizes their contents. A single summary report is generated. The report content and its order is configurable.

Creating a combined report

To run Combine Reports, go to:

        Toolbox | Utility Tools (Image utilities_closed_16_n_p) | Reports (Image reporttools_folder_closed_16_n_p) | Combine Reports (Image combine_reports_16_h_p)

To see a list of tools that produce reports that can be used as input, click on the (Image info_guide_16_h_p) icon in the top right corner of the input selection wizard (figure 27.3).

Image supported_reports-combined
Figure 27.3: Clicking on the info icon at the top right corner of the input selection wizard opens a window showing a list of tools that produce supported reports. Text entered in the field at the top limits the list to just tools with names containing the search term.

One section is included in the combined report for each report type provided as input, with the type determining the title of the corresponding section. See Report types and combined report content below for further details.

Specifying the order of the sections in the report

When more than one report type is provided as input, the order of the sections in the output report is configurable in the "Set order" wizard step:

Note: When using summary reports as input, the order of the sections in the output report reflects the order already present in the input summary reports. Thus, the section order cannot be manually defined in this case and the "Set order" wizard step will not be shown.

Image combinereports_order-combined
Figure 27.4: When more than one report type is provided as input, the order of the sections can be configured in the "Set order" wizard step.

When Combine Reports is included in a workflow, sections are ordered according to the order of the inputs. See Ordering inputs for information about ordering inputs in workflows.

Specifying the content of the report

The content of the report is configured in the "Set contents" wizard step (figure 27.5):

Image combinereports_content-combined
Figure 27.5: The content of the combined report is configured in the "Set contents" wizard step. Sections with a check in the box are included, while those without a check are excluded from the combined report. For visibility, sections where some contents have been excluded have checkboxes highlighted.

See Combine Reports output for information about the generated report.

Note: The options under "Report contents" and the summary section are most relevant for reports produced by tools in the CLC Genomics Workbench.

Reusing configurations

Configurations defined previously can be used in subsequent runs.

Configurations can be copied in two ways:

Copied configurations can be pasted into a text file for later use.

A copied configuration can be pasted into the wizard step using the Paste button.

Any existing settings in that wizard step will be overwritten.

The history of a report output by Combine Reports contains both the order of the sections (Order reports) and the excluded sections/subsections/summary items (Exclude) (figure 27.6). These can be selected, copied, and then pasted into the "Set order"/"Set contents" wizard steps, respectively, in a subsequent run. Alternatively, the entire history can be selected, copied, and then pasted in each wizard step. Only the relevant configuration is pasted into each step.

Image combinereports_history-combined
Figure 27.6: The history of a report output by Combine Reports with the parameters selected, ready to be copied.

Report types and combined report content

Reports that can be supplied as input have a report type. The type of a report affects the placement of its summary information in the output. Specifically:

The type of a report can be seen in the Element Info (Image element_info_16_n_p) view for that report.

Image combinable_element_info-combined
Figure 27.7: The type of a report can be found in the Element Info view of reports that are supported as input for tools that summarize reports.



Subsections