mlreportgen.report.Report.customizeReport

Class: mlreportgen.report.Report
Namespace: mlreportgen.report

Create class derived from Report class

Syntax

report = mlreportgen.report.Report.customizeReport(classpath)


Description

report = mlreportgen.report.Report.customizeReport(classpath) creates a report class definition file that defines a subclass of mlreportgen.report.Report at the location specified by classpath. The method also copies the default report 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 report class.

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 character vector or string scalar.

Value	Description
mlreportgen.report.Report.customizeReport("myFolder/MyClass")	Create MyClass.m in the subfolder myFolder of the current folder.
mlreportgen.report.Report.customizeReport("myFolder/@MyClass")	Create the report 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.Report.customizeReport("+myOrg/@MyClass")	Create the report 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

report — Path and file name of new report class

string scalar

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

Examples

Create Report Subclass

Create a new subclass named namespace.MyClassB of mlreportgen.report.Report.

mlreportgen.report.Report.customizeReport("+namespace/@MyClassB")

Version History

Introduced in R2017b