matlabtest.codequalitydashboard.exportMetrics

Export Code Quality Dashboard metrics to JSON

Since R2024a

Syntax

filePath = matlabtest.codequalitydashboard.exportMetrics

filePath = matlabtest.codequalitydashboard.exportMetrics(Name=Value)

Description

filePath = matlabtest.codequalitydashboard.exportMetrics exports the metric results from the Code Quality Dashboard to a JSON file. The JSON file also contains the relative path from the file to the MATLAB^® project.

filePath = matlabtest.codequalitydashboard.exportMetrics(Name=Value) specifies options using one or more name-value arguments.

Examples

Programmatically Update, Get, and Export Code Quality Dashboard Metrics

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/user/OneDrive - MathWorks/Documents/MATLAB/ExampleManager/user.examples/matlabtest-ex46234077/MATLABShortestPath"
        Metrics: [1×1 struct]

Export the metrics to a JSON file.

filePath = matlabtest.codequalitydashboard.exportMetrics

filePath = 
"C:\Users\user\OneDrive - MathWorks\Documents\MATLAB\ExampleManager\user.examples\matlabtest-ex46234077\MATLABShortestPath\CodeQualityMetrics.json"

Export Code Quality Dashboard Metrics and Specify File Name

This example shows how to specify the file name when you 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

Export the metrics to a JSON file called CQDMetrics.

filePath = matlabtest.codequalitydashboard.exportMetrics( ...
Filename="CQDMetrics")

filePath = 
"C:\Users\user\OneDrive - MathWorks\Documents\MATLAB\ExampleManager\user.examples\matlabtest-ex57589847\MATLABShortestPath\CQDMetrics.json"

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Filename="myMetrics"

Filename — JSON file name

string scalar | character vector

JSON file name, specified as a string scalar or a character vector. If you do not specify this name-value argument, the software names the file CodeQualityMetrics.

Example: Filename="myMetrics"

FolderPath — Folder in which to store JSON file

string scalar | character vector

Folder in which to store the JSON file, specified as a string scalar or character vector. You can specify the folder by using a relative or absolute file path. If you do not specify this name-value argument, the software stores the JSON file in the current folder.

Example: FolderPath="reports"

Output Arguments

filePath — File path to JSON file

string scalar

File path to the JSON file, returned as a string scalar. The software returns the file path as an absolute path unless you specify a relative path by using the FolderPath argument.

Version History

Introduced in R2024a

R2026a: JSON file contains relative path to project root

When you export metric results, the JSON file now contains the relative path from the file to the MATLAB project root folder.