getMetricMetaInformation

Class: slmetric.Engine
Package: slmetric

Obtain metric metadata

Since R2018b

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` — Metric engine object
`slmetric.Engine` object

Create an slmetric.Engine object.

metric_engine = slmetric.Engine();

Data Types: char

`MetricID` — Metric identifier
character vector | string scalar

Metric identifier for shipped or custom metrics. You can get metric identifiers by calling slmetric.metric.getAvailableMetrics.

Data Types: char

Output Arguments

expand all

`metaInfo` — Meta information object
`slmetric.metric.MetaInformation` object

For a metricID, the slmetric.metric.MetaInformation object contains its metadata. On the Metrics Dashboard, when you click a widget, this metadata appears on the table.

Examples

expand all

Obtain Metric Metadata

Obtain metadata 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 metadata, use the getMetricMetaInformation method.

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

The high-integrity check compliance metric contains this metadata:

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)'