Main Content

mlreportgen.report.RptFile.customizeReporter

Class: mlreportgen.report.RptFile
Package: mlreportgen.report

Create custom Report Explorer-based reporter class

Since R2019a

Syntax

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

Description

reporter = mlreportgen.report.RptFile.customizeReporter(classpath) creates a Report Explorer-based reporter (RptFile) class definition file that is a subclass of mlreportgen.report.RptFile. The file is created at the specified classpath location. The RptFile.customizeReporter method also copies the default RptFile templates to the <classpath>/resources/template folder. You can use the new class definition file as a starting point to design a custom Report Explorer-based reporter class for your report.

Input Arguments

expand all

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

ValueDescription
mlreportgen.report.RptFile.customizeReporter("myFolder/MyClass")Create MyClass.m in the subfolder myFolder of the current folder.
mlreportgen.report.RptFile.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.RptFile.customizeReporter("+myOrg/@MyClass")Create the reporter class in a class package 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

expand all

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

Examples

Create Custom Report Explorer-based Reporter

Create a custom Report Explorer-based reporter and its associated default templates. The derived class file is created at the specified path relative to the current working folder. In this example, the path to the MyRptExplRptr.m class file is <current working folder>/new_rptexpl_rptr/@MyRptExplRptr/MyRptExplRptr.m. The default RptFile templates are in the <current working folder>/new_rptexpl_rptr/@RptExplRptr/resources/templates folder.

import mlreportgen.report.*
RptFile.customizeReporter('new_rptexpl_rptr/@MyRptExplRptr');

After editing this new class file, you can use it as your RptFile reporter.

rptr = MyRptExplRptr();

Version History

Introduced in R2019a