Main Content

mlreportgen.report.SummaryTable.customizeReporter

Create class derived from summary table reporter class

Since R2022a

collapse all in page

    Syntax

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

    Description

    reporter = mlreportgen.report.SummaryTable.customizeReporter(classpath) creates a reporter class definition file that defines a subclass of mlreportgen.report.SummaryTable at the location specified by classPath. The method also copies the default reporter template to the resources/templates subfolder of the folder that contains the class definition file. Use the class definition file as a starting point to design a custom reporter class.

    example

    Examples

    collapse all

    Create a custom reporter and its associated default templates. This function creates the derived class file at the specified path relative to the current working folder.

    In this case, the path to the mySummaryTableReporter.m class file is <current_working_folder>/newSummaryTableReporter/@mySummaryTableReporter/mySummaryTableReporter.m.

    mlreportgen.report.SummaryTable.customizeReporter("mySummaryTable/@mySummaryTableReporter")

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

    The default are in the <current_working_folder>/newSummaryTableReporter/@mySummaryTableReporter/resources/templates folder.

    Input Arguments

    collapse all

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

    ValueDescription
    mlreportgen.report.SummaryTable.customizeReporter("myFolder/MyClass")Create MyClass.m in the subfolder myFolder of the current folder.
    mlreportgen.report.SummaryTable.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.SummaryTable.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

    collapse all

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

    Version History

    Introduced in R2022a

    See Also