mlreportgen.rpt2api.getDefaultReportTemplate

Return path of default report template that contains Report Explorer and report API styles

Since R2022b

Syntax

path = mlreportgen.rpt2api.getDefaultReportTemplate(type)

Description

path = mlreportgen.rpt2api.getDefaultReportTemplate(type) returns the file path for the default report template location for the report file type type. Each default report template contains the default Report Explorer and report API styles.

Examples

Get Default HTMTX Template Location

To get the location of the default HTMTX report template that contains the Report Explorer and Report API styles, enter:

myLocation = mlreportgen.rpt2api.getDefaultReportTemplate("html");

Use this file to generate HTML reports in the scripts generated by the rpt2api function.

Input Arguments

type — Report file type

"pdf" (default) | "pdfa" | "docx" | "html" | "html-file"

Report file type, specified as "pdf", "pdfa", "docx", "html", or "html-file". Each report file type corresponds to one of these template types:

Report File Type	Template File Type
"pdf"	PDFTX
"pdfa"	PDFTX
"docx"	DOTX
"html"	HTMTX
"html-file"	HTMT

Output Arguments

path — File path of default template

string scalar

File path of the default template, returned as a string scalar. The function returns the full file path and the file name extension.

Version History

Introduced in R2022b