mlreportgen.report.MATLABCode.customizeReporter

Class: mlreportgen.report.MATLABCode
Namespace: mlreportgen.report

Create subclass of mlreportgen.report.MATLABCode class

Since R2021a

Syntax

reporter = mlreportgen.report.MATLABCode.customizeReporter(classpath)


Description

reporter = mlreportgen.report.MATLABCode.customizeReporter(classpath) creates a reporter class definition file that defines a subclass of mlreportgen.report.MATLABCode at the location specified by classpath. The method also copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom MATLAB^® code reporter class for your report.

Input Arguments

classpath — Path and name of new class definition file

string scalar | character vector

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

Value	Description
mlreportgen.report.MATLABCode.customizeReporter("myFolder/MyClass")	Create MyClass.m in the subfolder myFolder of the current folder.
mlreportgen.report.MATLABCode.customizeReporter("myFolder/@MyClass")	Create the reporter class in a class folder by preceding the class name with the @ character. Do not specify the .m extension. See Folders Containing Class Definitions.
mlreportgen.report.MATLABCode.customizeReporter("+myOrg/@MyClass")	Create the reporter class in a class namespace by preceding the folder name with the + character.

Note

You can specify a relative path or an absolute path.

Data Types: string | char

Output Arguments

reporter — Path and file name of new reporter class

string scalar

Path and file name of the new reporter class, returned as a string scalar.

Examples

Create Custom MATLAB Code Reporter

Create a custom mlreportgen.report.MATLABCode reporter, myMATLABCode, and the associated default templates in the subfolder MyFolder of the current working folder.

mlreportgen.report.MATLABCode.customizeReporter("myFolder/myMATLABCode")

ans = 

    "myFolder\myMATLABCode.m"

Version History

Introduced in R2021a