getMetricMetaInformation

Class: slmetric.Engine
Namespace: slmetric

(To be removed) Obtain metric meta-information

expand all in page

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.

Syntax

metaInfo = getMetricMetaInformation(metric_engine,metricID)

Description

metaInfo = getMetricMetaInformation(metric_engine,metricID) returns the slmetric.metric.MetaInformation object corresponding to the metricID.

Input Arguments

expand all

Metric engine, specified as an slmetric.Engine object.

Metric identifier, specified as a character vector or string scalar. You can get the available metric identifiers by calling slmetric.metric.getAvailableMetrics on the metric engine object.

Data Types: char | string

Output Arguments

expand all

Meta-information for metric, returned as an slmetric.metric.MetaInformation object.

For more information, see slmetric.metric.MetaInformation.

Examples

expand all

Obtain meta-information for the high-integrity check compliance metric. This metric has a metric ID of mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178.

Create an slmetric.Engine object.

metric_engine = slmetric.Engine();

To obtain meta-information, use the getMetricMetaInformation method.

metaInfo = getMetricMetaInformation(metric_engine,...
'mathworks.metrics.ModelAdvisorCheckCompliance.hisl_do178')

The high-integrity check compliance metric contains this meta-information:

metaInfo = 

  MetaInformation with properties:

                       Name: 'Model Advisor standards check compliance for High Integrity'
                Description: 'Metric that counts the percentage of checks that passed for the High Integrity Model Advisor standards check grouping.'
              MeasuresNames: {2×1 cell}
    AggregatedMeasuresNames: {2×1 cell}
                  ValueName: 'Checks Passed'
        AggregatedValueName: 'Checks Passed (incl. Descendants)'

Version History

Introduced in R2018b

collapse all

See Also

| |

Topics