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"

Type of template, 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 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.

Examples

Create a Report Template

Create a copy of the HTML template for a report and save it with the name myReportTemplate in the mytemplates folder.

template = mlreportgen.report.Report.createTemplate...
     ('mytemplates/myReportTemplate','html');

After you modify the template, you can use it by setting the TemplatePath property of the mlreportgen.report.Report object.

Version History

Introduced in R2017b