Main Content

setHelp

Set custom help for custom authored Model Advisor checks

Syntax


checkObj.setHelp('Format',format, 'Path',custom path)

Description

checkObj.setHelp('Format',format, 'Path',custom path) sets custom help for custom authored Model Advisor checks.

Input Arguments

expand all

Format of the help file, specified as pdf or webpage.

Example: checkobj.setHelp('Format','webpage','path','c:/customhelp/help.html');

Data Types: char

Path of the help file for the custom check specified as a character vector.

Example: checkobj.setHelp('Format','pdf','path','c:/customhelp/help.pdf');

Data Types: char

Examples

Set webpage as custom help to a custom check

Create a check object.

checkobj = ModelAdvisor.Group('SimplePassFailCheck');

set webpage as custom help to your custom check.

checkobj.setHelp('Format','webpage','Path','c:/customhelp/help.html');

Version History

Introduced in R2022a