mlreportgen.report.Report.createTemplate

Class: mlreportgen.report.Report
Namespace: mlreportgen.report

Create report template

Syntax

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


Description

template = mlreportgen.report.Report.createTemplate(templatePath,templateType) 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 — Target path and file name of copy of template file

character vector | string scalar

Target path and file name of copy of template file, specified as a character vector or string scalar. If you specify templatePath without the file extension, the method creates the file with the extension of the copied template file. If you include the file extension, it must match the extension of the copied template file.

Data Types: char | string

templateType — Type of template

"html" | "html-file" | "docx" | "pdf"

Type of template, specified as "html", "html-file", "docx", or "pdf".

Data Types: char | string

Output Arguments

template — Path and file name of template copy

string scalar

Path and file name of the template copy, returned as a string scalar. The specified template type determines the file name extension of the template. For example, if the type argument is "pdf", the file name extension is ".pdftx".

Data Types: string

Examples

Create Reporter Template

Create a copy of the HTML template for your particular slreportgen.report class and save it with the name myTemplate in the mytemplates folder. This example uses the slreportgen.report.Reporter class, but the process is the same for any createTemplate method.

template = slreportgen.report.Reporter.createTemplate ...
     ("mytemplates/myTemplate","html");

After you modify the template, you can use it by setting the TemplateSrc property of a reporter to the path of the template file.

Version History

Introduced in R2017b