Main Content

mlreportgen.report.ListOfCaptions.customizeReporter

Class: mlreportgen.report.ListOfCaptions
Package: mlreportgen.report

Create custom list of captions reporter class

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

expand all

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

You can specify a relative path or an absolute path. For example, this code creates MyClass.m in the subfolder myFolder of the current folder.

mlreportgen.report.ListOfCaptions.customizeReporter("myFolder/MyClass")

To create the reporter class in a class folder, precede the class name with the @ character. Do not specify the .m extension. For example, this code creates MyClass.m in the subfolder myFolder/@MyClass in the current folder.

mlreportgen.report.ListOfCaptions.customizeReporter("myFolder/@MyClass")
See Folders Containing Class Definitions.

To create the reporter class in a class package, precede the folder name with the + character. For example, this code creates an list of captions reporter in the myOrg package folder in the current folder.

mlreportgen.report.ListOfCaptions.customizeReporter("+myOrg/@MyClass");

Output Arguments

expand all

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

Examples

expand all

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"
Introduced in R2020b