mlreportgen.report.ListOfTables.createTemplate

Class: mlreportgen.report.ListOfTables
Package: mlreportgen.report

Create list of tables reporter template

Syntax

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


Description

template = mlreportgen.report.ListOfTables.createTemplate(templatePath,type) creates a copy of the mlreportgen.report.ListOfTables reporter template for the report type specified by type at the location specified by templatePath. You can use the copied template as a starting point to design a custom list of tables reporter 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 copy of the template, returned as a string scalar. The file name extension of the template is based on the specified template type. For example, if the type argument is 'pdf', the file name extension is .pdftx.

Examples

Create a List of Tables Reporter Template

Create a copy of the HTML template for the mlreportgen.report.ListOfTables reporter and save it with the name myListOfTablesTemplate in the mytemplates folder.

template = mlreportgen.report.ListOfTables.createTemplate...
     ('mytemplates/myListOfTablesTemplate','html');

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

Version History

Introduced in R2020b