Documentation updates

Author: TomDonoghue

.gitignore

@@ -0,0 +1,2 @@
+# Ignore notebook checkpoint files
+.ipynb_checkpoints/*

LonePSD_A_matlab_preprocessing.m

@@ -1,12 +1,25 @@
-%% Matlab PreProcessing - Multiple PSDs
+%% Matlab PreProcessing - Lone PSD
+%
+% This script is an example, with a single power spectrum,
+% of integrating Python FOOOF into a Matlab workflow. 
+% 
+% It is part of a trio of files that must be run in order:
+% - `LonePSD_A_*
+% - `LonePSD_B_*
+% - `LonePSD_C_*
+%
 
-% Load data
+%% Load Data
+
+% Load a single channel of data
 load('dat/ch_dat_one.mat');
 
 %% Calculate Power Spectra
 
 % Calculate a power spectrum with Welch's method
 [psd, freqs] = pwelch(ch_dat_one, 500, [], [], s_rate);
 
+%% Save Out Data
+
 % Save the power spectra out to mat files
 save('power_spectrum', 'freqs', 'psd');

LonePSD_B_python_fooofing.ipynb

@@ -1,8 +1,23 @@
-%% Load and Analyze FOOOF Results in Matlab
+%% Load and Analyze FOOOF Results in Matlab - Single PSD
+%
+% This script is an example, with a single power spectrum,
+% of integrating Python FOOOF into a Matlab workflow. 
+% 
+% It is part of a trio of files that must be run in order:
+% - `LonePSD_A_*
+% - `LonePSD_B_*
+% - `LonePSD_C_*
+%
+% This code must be run after `LonePSD_B_python_fooofing.ipynb` has been run. 
+%
+
+%% Load Data
 
 % Load FOOOF results
 fooof_results = load('fooof_results.mat');
 
+%% Explore FOOOF Results
+
 % Check out FOOOF results
 fooof_results
 

LonePSD_C_matlab_analysis.m

@@ -1,6 +1,17 @@
 %% Matlab PreProcessing - Multiple PSDs
+% 
+% This script is an example, with multiple power spectra,
+% of integrating Python FOOOF into a Matlab workflow. 
+% 
+% It is part of a trio of files that must be run in order:
+% - `MultiPSD_A_*
+% - `MultiPSD_B_*
+% - `MultiPSD_C_*
+%
 
-% Load data
+%% Load Data
+
+% Load two channels of time series data
 load('dat/ch_dat_one.mat');
 load('dat/ch_dat_two.mat');
 
@@ -12,5 +23,7 @@
 % Calculate power spectra with Welch's method
 [psds, freqs] = pwelch(chs_dat, 500, [], [], s_rate);
 
+%% Save Out Data
+
 % Save the power spectra out to mat files
 save('power_spectra', 'freqs', 'psds');

MultiPSD_A_matlab_preprocessing.m

@@ -1,4 +1,15 @@
-%% Load and Analyze FOOOF Results in Matlab
+%% Load and Analyze FOOOF Results in Matlab - Multiple PSDs
+% 
+% This script is an example, with multiple power spectra,
+% of integrating Python FOOOF into a Matlab workflow. 
+% 
+% It is part of a trio of files that must be run in order:
+% - `MultiPSD_A_*
+% - `MultiPSD_B_*
+% - `MultiPSD_C_*
+%
+% This code must be run after `MultiPSD_B_python_fooofing.ipynb has been run.
+%
 
 %% Load a specific variable that was saved out to a mat file