Main Content

mlreportgen.report.MATLABVariable.customizeReporter

Class: mlreportgen.report.MATLABVariable
Package: mlreportgen.report

Create custom MATLAB variable reporter class

Syntax

rptr = mlreportgen.report.MATLABVariable.customizeReporter(classpath)

Description

rptr = mlreportgen.report.MATLABVariable.customizeReporter(classpath) creates a MATLAB® variable class definition file that is a subclass of mlreportgen.report.MATLABVariable. The file is created at the specified classpath location. The MATLABVariable.customizeReporter method also copies the default MATLABVariable templates to the <classpath>/resources/template folder. You can use the class definition file as a starting point to design a custom MATLABVariable class for your report.

Input Arguments

expand all

Location of custom MATLAB variable class, specified as a string or character array. The classpath argument also supports specifying a folder with @ before the class name.

Output Arguments

expand all

MATLAB variable reporter path, returned as the string specifying the path to the derived report class file.

Examples

Create Custom MATLAB Variable Reporter

Create a custom MATLAB variable reporter and its associated default templates. The derived class file is created at the specified path relative to the current working folder. In this case, the path to the MyMATLABvar.m class file is <current working folder>/newVar/@MyMATLABvar/MyMATLABvar.m. The default title page templates are in the <current working folder>/newVar/@MyMATLABvar/resources/templates folder.

import mlreportgen.report.*
MATLABVariable.customizeReporter('newVar/@MyMATLABvar')

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

mvar = MyMATLABvar();

Introduced in R2018b