Main Content

mlreportgen.report.TitlePage.customizeReporter

Class: mlreportgen.report.TitlePage
Namespace: mlreportgen.report

Create custom title page reporter class

expand all in page

Syntax

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

Description

reporter = mlreportgen.report.TitlePage.customizeReporter(classpath) creates a title page class definition file that is a subclass of mlreportgen.report.TitlePage. The file is created at the specified classpath location. The TitlePage.customizeReporter method also copies the default title page templates to the <classpath>/resources/template folder. You can use the new class definition file as a starting point to design a custom title page class for your report. You can customize the title page class by, for example, adding new content holes and properties.

Input Arguments

expand all

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

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

expand all

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

Examples

expand all

  1. Create a custom title page 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 MyTitlePage.m class file is <current working folder>/newTitlePage/@MyTitlePage/MyTitlePage.m. The default title page templates are in the <current working folder>/newTitlePage/@MyTitlePage/resources/templates folder.

    ('newTitlePg/@MyTitlePage');

  2. After editing this new class file, you can use it as your title page reporter.

    tp = MyTitlePage();

Version History

Introduced in R2017b

See Also

| | |