mlreportgen.report.Report.createTemplate

Class: mlreportgen.report.Report
Package: mlreportgen.report

Create report template

Syntax

template = mlreportgen.report.Report.createTemplate(templatePath,type)


Description

template = mlreportgen.report.Report.createTemplate(templatePath,type) creates a copy of the default report template specified by type at the location specified by templatePath. You can use the copied template to design a custom template for your report.

Input Arguments

templatePath — Path and file name of new template

character vector | string scalar

Path and file name of the new template, specified as a character vector or string scalar.

type — Type of template

'html' | 'html-file' | 'docx' | 'pdf'

Format of the output, specified as 'html', 'html-file', 'docx', or 'pdf'.

Output Arguments

template — Path and file name of template copy

string scalar

Path and file name of the copy of the template, returned as a string scalar. The file name extension of the template is assigned based on the specified output type. For example, if type is 'pdf', the file name extension is .pdftx.

Examples

Create a Report Template

Before you run this example, create a copy of the default HTML Report template in the mytemplates folder. Name the copied template myReporttemplate.htmtx. Edit the template as desired. To use the new template for the title page, assign its path to the TitlePage TemplateSrc property.TemplateSrc property.

import mlreportgen.report.*
rpt = Report('My Report','html');
template = Report.createTemplate('mytemplates\myReportTemplate','html');
rpt.TemplateSrc = template;