Report templates¶

VIP outputs a standalone HTML report that can be viewed in any modern browser. The report is based on the input sample sheet information and the output variant vcf data.

Default¶

As a default VIP uses a report template that is suitable for most analysis:

Above: default report template

Customization¶

Using the vcf.report.template parameter (see here) it is possible to specify a different report template to create reports tailered to your needs.

The following repositories might be of interest when creating a new report template:

• vip-report-api
• vip-report-template
• vip-report-vcf
• vite-plugin-inline

The vip-report tool creates reports based on a report template as described in the following repositories:

• vip-report
• vip-utils

Configuration¶

A configuration .json file can be used in combination with a vcf.report.template to create reports that e.g. show specific variant content or variant filters. The allowed contents of a configuration .json file depends on the vcf.report.template used. For the default vcf.report.template the configuration options are described here.