Skip to content

Add precision argument to projectClass.writeScript method #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StephenNneji merged 3 commits into from
May 29, 2026
Merged

Add precision argument to projectClass.writeScript method #441

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4bdf1e
Add precision argument to writeScript method
StephenNneji May 28, 2026
4e0b0e1
Change to windows-2022
StephenNneji May 28, 2026
6bdf350
GitHub is changing macos-latest to macos 26 so set our runner to maco…
StephenNneji May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/runTests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
build_and_test_mex:
strategy:
matrix:
platform: [windows-latest, ubuntu-22.04, macos-15-intel, macos-latest]
platform: [windows-2022, ubuntu-22.04, macos-15-intel, macos-latest]
runs-on: ${{ matrix.platform }}
needs: [build_cpp]

Expand Down
20 changes: 13 additions & 7 deletions API/projectClass/projectClass.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1322,11 +1322,14 @@ function writeScript(obj, options)
% The name to use for the project object in the script.
% path : string or char array, default: 'projectScript.m'
% The relative or absolute file path where the script should be written to.
% precision : whole number, default: 4
% The number of significant figures written into the script.

arguments
obj
options.objName {mustBeTextScalar} = 'project'
options.path {mustBeTextScalar} = 'projectScript.m'
options.precision (1,1) {mustBeInteger} = 4
end

% Need to ensure correct format for script name
Expand All @@ -1343,7 +1346,7 @@ function writeScript(obj, options)
throw(exceptions.invalidValue(sprintf('The filename chosen for the script has the "%s" extension, rather than a MATLAB ".m" extension', extension)));
end

script = obj.toScript(objName=options.objName);
script = obj.toScript(objName=options.objName, precision=options.precision);
fileID = fopen(options.path, 'w');
fprintf(fileID, '%s\n', script);
fclose(fileID);
Expand Down Expand Up @@ -1506,11 +1509,13 @@ function setLayersAndContrasts(obj, oldModel)
% Keyword/value pair to properties to update for the specific parameter.
% * objName (string or char array, default: 'project') the name to use for the project object in the script.
% * exportData (logical, default: true) indicates if the data should be exported to file otherwise the data is written into the script.
% * precision (whole number, default: 15) the number of significant figures written into the script.

arguments
obj
options.objName {mustBeTextScalar} = 'project'
options.exportData {mustBeA(options.exportData, 'logical')} = true
options.precision (1,1) {mustBeInteger} = 15
end
script = "";
script = script + sprintf("%s\n\n", '% THIS FILE IS GENERATED FROM RAT VIA THE "WRITESCRIPT" ROUTINE. IT IS NOT PART OF THE RAT CODE.');
Expand All @@ -1529,7 +1534,8 @@ function setLayersAndContrasts(obj, oldModel)
for i=1:height(obj.parameters.varTable)
% Set protected parameters
if any(strcmpi(obj.parameters.varTable{i, 1}, obj.protectedParameters))
script = script + sprintf(options.objName + ".setParameter(%d, 'min', %.15g, 'value', %.15g, 'max', %.15g, 'fit', %s, 'priorType', '%s', 'mu', %.15g, 'sigma', %.15g);\n", ...
paramSpec = sprintf(".setParameter(%%d, 'min', %%.%1$dg, 'value', %%.%1$dg, 'max', %%.%1$dg, 'fit', %%s, 'priorType', '%%s', 'mu', %%.%1$dg, 'sigma', %%.%1$dg);\n", options.precision);
script = script + sprintf(options.objName + paramSpec, ...
i, obj.parameters.varTable{i, 2}, obj.parameters.varTable{i, 3}, obj.parameters.varTable{i, 4}, string(obj.parameters.varTable{i, 5}), ...
obj.parameters.varTable{i, 6}, obj.parameters.varTable{i, 7}, obj.parameters.varTable{i, 8});
% Add non-protected parameters to a parameter group
Expand All @@ -1547,7 +1553,7 @@ function setLayersAndContrasts(obj, oldModel)
if size(paramGroup, 1) > 0
script = script + sprintf("paramGroup = {\n");
for i = 1:size(paramGroup, 1)
paramSpec = blanks(14) + "{'%s', %.15g, %.15g, %.15g, %s, '%s', %.15g, %.15g};\n";
paramSpec = blanks(14) + sprintf("{'%%s', %%.%1$dg, %%.%1$dg, %%.%1$dg, %%s, '%%s', %%.%1$dg, %%.%1$dg};\n", options.precision);
script = script + sprintf(paramSpec, paramGroup{i}{:});
end
script = script + sprintf(blanks(14) + "%s\n\n", "};");
Expand Down Expand Up @@ -1590,7 +1596,7 @@ function setLayersAndContrasts(obj, oldModel)
paramTable{5, j} = string(paramTable{5, j});
end
% Add the parameters that have been defined
paramSpec = options.objName + "." + addRoutine + "('%s', %.15g, %.15g, %.15g, %s, '%s', %.15g, %.15g);\n";
paramSpec = options.objName + "." + addRoutine + sprintf("('%%s', %%.%1$dg, %%.%1$dg, %%.%1$dg, %%s, '%%s', %%.%1$dg, %%.%1$dg);\n", options.precision);
script = script + sprintf(paramSpec, paramTable{:});
script = script + newline;

Expand Down Expand Up @@ -1626,18 +1632,18 @@ function setLayersAndContrasts(obj, oldModel)
script = script + sprintf("data_%d = readmatrix('%s');\n", i, "data_" + string(i) + ".dat");
script = script + sprintf(options.objName + ".addData('%s', data_%d);\n", obj.data.varTable{i, 1}, i);
else
script = script + sprintf("data_%d = %s;\n", i, mat2str(obj.data.varTable{i, 2}{:}, 15));
script = script + sprintf("data_%d = %s;\n", i, mat2str(obj.data.varTable{i, 2}{:}, options.precision));
script = script + sprintf(options.objName + ".addData('%s', data_%d);\n", obj.data.varTable{i, 1}, i);
end
end

% Also need to set dataRange and simRange explicitly as they
% are optional
if ~isempty(obj.data.varTable{i, 3}{:})
script = script + sprintf(options.objName + ".setData(%d, 'dataRange', [%.15g %.15g]);\n", i, obj.data.varTable{i, 3}{:});
script = script + sprintf(options.objName + sprintf(".setData(%%d, 'dataRange', [%%.%1$dg %%.%1$dg]);\n", options.precision), i, obj.data.varTable{i, 3}{:});
end
if ~isempty(obj.data.varTable{i, 4}{:})
script = script + sprintf(options.objName + ".setData(%d, 'simRange', [%.15g %.15g]);\n", i, obj.data.varTable{i, 4}{:});
script = script + sprintf(options.objName + sprintf(".setData(%%d, 'simRange', [%%.%1$dg %%.%1$dg]);\n", options.precision), i, obj.data.varTable{i, 4}{:});
end

script = script + newline;
Expand Down
2 changes: 1 addition & 1 deletion tests/testExamples.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ function testWriteScript(testCase, exampleScriptFile)
% Write the script using a deep copy of the project
clonedProblem = problem.clone();
testCase.verifyNotSameHandle(clonedProblem, problem);
clonedProblem.writeScript(objName="scriptProblem", path="projectScript");
clonedProblem.writeScript(objName="scriptProblem", path="projectScript", precision=15);
run("projectScript.m");

% Test general properties
Expand Down
Loading