mlreportgen.report.ListOfCaptions.customizeReporter

Class: mlreportgen.report.ListOfCaptions
Namespace: mlreportgen.report

Create custom list of captions reporter class

Since R2020b

Syntax

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


Description

reporter = mlreportgen.report.ListOfCaptions.customizeReporter(classpath) creates a class definition file that defines a subclass of mlreportgen.report.ListOfCaptions at the location specified by classpath. This 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 list of captions 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.ListOfCaptions.customizeReporter("myFolder/MyClass")	Create MyClass.m in the subfolder myFolder of the current folder.
mlreportgen.report.ListOfCaptions.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.ListOfCaptions.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 List of Captions Reporter

Create a custom list of captions reporter, MyListOfCaptions, and the associated default templates in the subfolder MyFolder of the current working folder.

mlreportgen.report.ListOfCaptions.customizeReporter('MyFolder/MyListOfCaptions')

ans = 

    "MyFolder\MyListOfCaptions.m"

Version History

Introduced in R2020b