General purpose

f_save_analysis

Code

function f_save_analysis(settings, sb, results, model_folders, plots)
% This function saves the analysis results to the specified folder.
%
% Inputs:
% - settings: The settings for the analysis.
% - sb: The subject data.
% - results: The results of the analysis.
% - model_folders: The structure containing folder paths for the model.
% - plots: The plots generated from the analysis.
%
% Outputs:
% - None. The function saves the analysis data to a .mat file in the
% specified folder.
%
% Used Functions:
% - mkdir: Create a new folder if it does not exist.
% - addpath: Add the analysis date folder to the MATLAB search path.
% - save: Save the variables to a .mat file.
%
% Variables
% Loaded:
% - None.
%
% Initialized:
% - Results_Folder: The main results folder path.
% - Analysis_folder: The main analysis folder path.
% - Analysis_date_folder: The folder path with the analysis date.
%
% Persistent:
% - None.

% Set the main results folder, analysis folder, and analysis date folder
Results_Folder = model_folders.model.results.main;
Analysis_folder = model_folders.model.results.analysis.main;
Analysis_date_folder = model_folders.model.results.analysis.date.main;

% Create the directories if they do not exist
[~, ~] = mkdir(Results_Folder);
[~, ~] = mkdir(Analysis_folder);
[~, ~] = mkdir(Analysis_date_folder);

% Add the analysis date folder to the MATLAB path
addpath(Analysis_date_folder)

% Save the analysis data to the Analysis.mat file
try
    save (Analysis_date_folder + "Analysis.mat", 'settings', 'sb', ...
        'results', 'model_folders');
catch
    disp("failed to save analysis");
end
try
    save (Analysis_date_folder + "Plots.mat", 'plots');
catch
    disp("failed to save plots");
end
end

• Inputs

• Outputs

• Calls

• Loads

f_save_plots

Code

function f_save_plots(model_folders)

Analysis_date_folder = model_folders.model.results.analysis.date.main;

FigList = findobj(allchild(0), 'flat', 'Type', 'figure');

[~, ~] = mkdir(Analysis_date_folder);

savefig(FigList(end: -1: 1), ...
    Analysis_date_folder + "All_figures.fig");

for iFig = 1:length(FigList)
    FigHandle = FigList(iFig);
    FigName   = get(FigHandle, 'Name');
    
    saveas(FigHandle, Analysis_date_folder + FigName + ".png")
end
end

• Inputs

• Outputs

• Calls

• Loads

f_get_outputs

Code

function [n_outputs, output_names] = f_get_outputs(settings, sbtab)
% Retrieves the total number of outputs and their names from a set of
% experiment runs. It iterates through all the experiment runs specified in the
% input 'stg' and, for each run, extracts the output names from the
% corresponding dataset in 'sbtab'. It appends each output name to a cell
% array, 'out_name', with a prefix indicating the experiment run number.
% Finally, it returns the total number of outputs and the cell array of
% output names.
% 
% Inputs:
% - stg: A structure containing experiment run indices
% - sbtab: A structure containing datasets with output information for each
% experiment run
%
% Outputs:
% - n_outputs: The total number of outputs across all experiment runs
% - output_names: A cell array containing the output names, prefixed with
% the experiment run number
%
% Used Functions:
% (none)
%
% Variables:
% Loaded:
% (none)
%
% Initialized:
% - out_name: A cell array to store output names
%
% Persistent:
% (none)

% Initialize an empty cell array to store output names
out_name = [];

% Loop through all experiment runs specified in 'stg'
for n = settings.exprun
    % Loop through all outputs in the current experiment run
    for j = 1:size(sbtab.datasets(n).output, 2)
        % Add the output name to 'out_name' with a prefix indicating the
        % experiment run
        out_name{end + 1} = ...
            {"E" + (n - 1) + " " + string(sbtab.datasets(n).output{1, j})};
    end
end
% Get the total number of outputs
n_outputs = size(out_name, 2);

% Assign the output names to 'output_names'
output_names = out_name;
end

• Inputs

• Outputs

• Calls

• Loads