itpseq.DataSet.report#

DataSet.report(template='report', output=None)[source]#

Create a report for the DataSet.

Parameters:

template (str, optional) – Which template to use for the report. There is currently only one template, but you can add custom ones in itpseq/templates/.
output (str, optional) – Name of the output file in which to write the report. The type of the file in inferred from the extention. Only PDF (.pdf) and HTML (.html) are supported.

Examples

Create a PDF report

>>> dataset.report(output='my_report.pdf')

Create an HTML report

>>> dataset.report(output='my_report.html')

Create an HTML report in the notebook

>>> dataset.report()