Main Content

matlabtest.codequalitydashboard.getMetrics

Get metrics from Code Quality Dashboard

Since R2024a

collapse all in page

    Syntax

    info = matlabtest.codequalitydashboard.getMetrics

    Description

    info = matlabtest.codequalitydashboard.getMetrics returns information about the current project and the code quality metrics from the Code Quality Dashboard.

    example

    Examples

    collapse all

    Open Live Script

    This example shows how to update, get, and export metrics from the Code Quality Dashboard.

    Open the ShortestPath project.

    openProject("MATLABShortestPath");

    Open the Code Quality Dashboard.

    codeQualityDashboard

    Run the tests in the project, collect coverage for the tests, verify the requirements, and update the metrics in the dashboard.

    matlabtest.codequalitydashboard.runTestsAndRefreshData
    pathLength = 
3

    Get the metrics from the Code Quality Dashboard.

    metrics = matlabtest.codequalitydashboard.getMetrics
    metrics = struct with fields:
    ProjectPath: "C:\Users\jdoe\MATLAB\MATLABShortestPath"
        Metrics: [1×1 struct]

    Export the metrics to a JSON file.

    filePath = matlabtest.codequalitydashboard.exportMetrics
    filePath = 
"C:\Users\jdoe\MATLAB\MATLABShortestPath\CodeQualityMetrics.json"

    Output Arguments

    collapse all

    Code quality metric information, returned as a structure with these fields:

    Project root folder path, returned as a string.

    Code Quality Dashboard metric results, returned as a structure with these fields:

    Code Analyzer metric results, returned as a structure with these fields:

    Date and time when the software collected the results, returned as a character vector.

    Stale metric indicator, returned as a 1 or 0 of data type logical.

    Code Analyzer metric data, returned as a structure with these fields:

    Number of errors, returned as a double.

    Number of warnings, returned as a double.

    Number of informational messages, returned as a double.

    Test metric results, returned as a structure with these fields:

    Date and time when the software collected the results, returned as a character vector.

    Stale metric indicator, returned as a 1 or 0 of data type logical.

    Test result metric data, returned as a structure with these fields:

    Number of passed tests, returned as a double.

    Number of failed tests, returned as a double.

    Number of incomplete tests, returned as a double.

    Number of tests that have not run, returned as a double.

    Total number of tests, returned as a double.

    Code coverage metric results, returned as a structure with these fields:

    Date and time when the software collected the results, returned as a character vector.

    Stale metric indicator, returned as a 1 or 0 of data type logical.

    Code coverage metric data, returned as a structure with these fields:

    Function coverage percentage, returned as a double.

    Statement coverage percentage, returned as a double.

    Decision coverage percentage, returned as a double.

    Condition coverage percentage, returned as a double.

    MC/DC coverage percentage, returned as a double.

    Since R2024b

    Generated code coverage metric results, returned as a structure with these fields:

    Date and time when the software collected the results, returned as a character vector.

    Stale metric indicator, returned as a 1 or 0 of data type logical.

    Code coverage metric data, returned as a structure with these fields:

    Function coverage percentage, returned as a double.

    Statement coverage percentage, returned as a double.

    Decision coverage percentage, returned as a double.

    Condition coverage percentage, returned as a double.

    MC/DC coverage percentage, returned as a double.

    Requirement verification metric results, returned as a structure with these fields:

    Date and time when the software collected the results, returned as a character vector.

    Stale metric indicator, returned as a 1 or 0 of data type logical.

    Requirement verification metric data, returned as a structure with these fields:

    Number of requirements that link to passed tests, returned as a double.

    Number of requirements that link to failed tests, returned as a double.

    Number of requirements that link to tests that have not run, returned as a double.

    Number of requirements that do not link to tests, returned as a double.

    Total number of requirements, returned as a double.

    Version History

    Introduced in R2024a

    expand all

    See Also

    Apps

    Functions

    Topics