Added some NOHELPINFO tag-words, worked on help docs etc. Related to #10

issue
mmagnuski · Aug 16, 2014 · f6cef90 · f6cef90
1 parent 193eea0
commit f6cef90
Show file tree

Hide file tree

Showing 26 changed files with 67 additions and 7 deletions.
diff --git a/ICAw_add_badch.m b/ICAw_add_badch.m
@@ -9,6 +9,8 @@
 % channel labels:
 
 if ~isnumeric(badch) && ischar(badch)
+    % CHANGE - doesn't make sense to require EEG in base workspace for this
+    % CHANGE - chanlocs should be in datainfo
     chans = strsplit(badch, ' ');
     badch = zeros(size(chans));
 

diff --git a/ICAw_add_remep.m b/ICAw_add_remep.m
@@ -1,12 +1,12 @@
 function ICAw = ICAw_add_remep(ICAw, r, ep_rem)
 
 % ICAw_add_remep() function allows for adding
-% additiona removals to the ICAw structure database
+% additional removals to the ICAw structure database
 % 
 % ICAw = ICAw_add_remep(ICAw, r, rem_ep)
 % Where ICAw is the ICAw structure, r is
-% register index to update and rem_ep is
-% a 1 by N vector with info on rejections
+% the record index to update and rem_ep is
+% a 1 by N vector with epoch indices to remove
 
 % create vector with epoch indices:
 eps = 1:max([max(ICAw(r).removed), max(ep_rem)])+1;

diff --git a/ICAw_addloc.m b/ICAw_addloc.m
@@ -1,5 +1,8 @@
 function ICAw_addloc(ICAw, varargin)
 
+% NOHELPINFO
+% NON-UNIVERSAL
+
 %% ustaw mastref i avgref:
 % oba na false je¿eli bez rereferencji (tylko lokalizacje elektr)
 % tylko avref je¿eli referencja do œredniej

diff --git a/ICAw_addpath.m b/ICAw_addpath.m
@@ -13,6 +13,7 @@
 % TODOs:
 % [ ] 'ignore cleanline' when all files have been
 %      brought to a single folder
+% CONSIDER - how intermediate files should be treated and located
 
 cll = 'CleanLine\';
 for r = 1:length(ICAw)

diff --git a/ICAw_addrej.m b/ICAw_addrej.m
@@ -1,9 +1,12 @@
 function ICAw = ICAw_addrej(ICAw, r, rej)
 
+% ICAw = ICAw_addrej(ICAw, r, rej)
 % function that adds rejection info to ICAw database
 % this is different from changing 'userrem' or 'autorem'
 % fields - the rejections added by ICAw_addrej are final
 % (or accepted in other words)
+%
+% FIXHELPINFO
 
 % TODOs:
 % [ ] compare with ICAw_add_remep

diff --git a/ICAw_addw.m b/ICAw_addw.m
@@ -1,5 +1,8 @@
 function ICAw = ICAw_addw(ICAw, r, EEG)
-
+
+% NOHELPINFO
+% NOTUSED
+
         ICAw(r).icaweights = EEG.icaweights;
         ICAw(r).icasphere = EEG.icasphere;
         ICAw(r).icawinv = EEG.icawinv;

diff --git a/ICAw_adj_check.m b/ICAw_adj_check.m
@@ -1,3 +1,7 @@
+% NON-UNIVERSAL
+% CHANGE
+% BRANCH
+
 % adjust checker
 % shows components marked as artifacts
 % by adjust. Only components belonging

diff --git a/ICAw_adj_conf_GUI.m b/ICAw_adj_conf_GUI.m
@@ -1,4 +1,8 @@
 function varargout = ICAw_adj_conf_GUI(varargin)
+
+% NOHELPINDO
+% GUIDE SUCKS
+%
 % ICAW_ADJ_CONF_GUI MATLAB code for ICAw_adj_conf_GUI.fig
 %      ICAW_ADJ_CONF_GUI, by itself, creates a new ICAW_ADJ_CONF_GUI or raises the existing
 %      singleton*.

diff --git a/ICAw_adjusting_ICA.m b/ICAw_adjusting_ICA.m
@@ -1,3 +1,6 @@
+% NON-UNIVERSAL
+% BRANCH
+
 % function for running ADJUST on files
 % stored in ICAw base
 

diff --git a/ICAw_apply_icarem.m b/ICAw_apply_icarem.m
@@ -2,6 +2,8 @@
 
 % Applies remove and ifremove info from ICA_desc
 % to ICAw, cool stuff!
+% 
+% FIXHELPINFO
 
 % if r's not given - assume all records:
 if ~exist('rec', 'var')

diff --git a/ICAw_applyrej.m b/ICAw_applyrej.m
@@ -1,6 +1,6 @@
 function ICAw = ICAw_applyrej(ICAw, rs, varargin)
 
-% ADD help text
+% NOHELPINFO
 % function used to apply rejections to ICAw database
 
 % written by M Magnuski, [email protected]

diff --git a/ICAw_badchan_summary.m b/ICAw_badchan_summary.m
@@ -1,8 +1,11 @@
 function badelec = ICAw_badchan_summary(ICAw, chanloc)
 
+% badelec = ICAw_badchan_summary(ICAw, chanloc)
 % checks bad channels as stated in
 % ICAw.badchan and plots the summary
 % - topoplot of bad channels occurrance
+%
+% FIXHELPINFO
 
 % get number of electrodes
 elen = length(chanloc);

diff --git a/ICAw_bringversion.m b/ICAw_bringversion.m
@@ -1,5 +1,7 @@
 function ICAw = ICAw_bringversion(ICAw, r, verf)
 
+% NOHELPINFO
+
 % TODOs:
 % [ ] CHECK more thoroughly - testing
 % [ ] if some fields are filled but are not present

diff --git a/ICAw_buildbase.m b/ICAw_buildbase.m
@@ -4,6 +4,9 @@
 % from files in a given folder
 %
 % ICAw = ICAw_buildbase(filepath)
+%
+% FIXHELPINFO
+% CHANGE - PRIORITY
 
 % TODOS:
 % [ ] change from loop to one call to

diff --git a/ICAw_checkbase.m b/ICAw_checkbase.m
@@ -1,5 +1,9 @@
 function [answer, ans_adr] = ICAw_checkbase(ICAbase, EEG, varargin)
 
+% Its a shitty function that noone really uses.
+% Needs to be changed/rewritten to be useful.
+% One possibility - recursion instead of those dumb nested ifs
+%
 % [answer, ans_adr] = ICAw_checkbase(ICAbase, EEG, varargin)
 % Function used for checking whether given EEG structure is
 % represented in a database and to what degree.

diff --git a/ICAw_checkbase_present.m b/ICAw_checkbase_present.m
@@ -20,6 +20,9 @@
 %                     not)
 %                     
 % ans_adr = 
+%
+% FIXHELPINFO
+% FINISH UP
 
 if nargin>2
     fields_to_check = varargin{1};

diff --git a/ICAw_checkfields.m b/ICAw_checkfields.m
@@ -1,7 +1,10 @@
 function fldch = ICAw_checkfields(ICAw, r, flds, varargin)
 
-% ADD help text
+% NOHELPINFO
+%
 % function used to check fields of ICAw (or any other structure)
+
+% CHANGE - establish copyright and license info (everywhere)
 % written by Miko³aj Magnuski, [email protected]
 
 %% defaults

diff --git a/ICAw_copybase.m b/ICAw_copybase.m
@@ -23,7 +23,7 @@
 %         some content then this content is copied
 %         rather than the content of the other data-
 %         base's field. (see example 2)
-% ICAw2 - structure which to copy fields from
+% ICAw2 - structure to copy fields from
 % 
 % ===EXAMPLES===
 %    Example 1:

diff --git a/ICAw_copyrec.m b/ICAw_copyrec.m
@@ -1,5 +1,7 @@
 function ICAw = ICAw_copyrec(ICAw, num)
 
+% NOHELPINFO
+
 len = length(ICAw);
 newf = len + 1;
 fld = fields(ICAw);

diff --git a/ICAw_create_base.m b/ICAw_create_base.m
@@ -1,7 +1,9 @@
 function varargout = ICAw_create_base(varargin)
+
 % ICAW_CREATE_BASE - GUI for creating ICAw database
 % The same can be performed using specific calls
 % to functions like ICAw_buildbase etc.
+% FIXHELPINFO
 
 % Last Modified by GUIDE v2.5 24-May-2014 17:54:02
 

diff --git a/ICAw_dipfit.m b/ICAw_dipfit.m
@@ -1,5 +1,7 @@
 function ICAw = ICAw_dipfit(ICAw, varargin)
 
+% NOHELPINFO
+
 % =================
 % info for hackers:
 % 

diff --git a/badchan_ind.m b/badchan_ind.m
@@ -3,6 +3,12 @@
 %     deleted
 % 
 %     (MZ)
+%
+%
+%     Potentially problematic if used more than once on such a file
+%     I don't think we should support undocumented missing channels.
+%     CHANGE - add field informing about missing channels to datainfo field
+%     (MM)
 
 function corrected=badchan_ind(newICAw,r, chanlocs)
 

diff --git a/check_dipfit_status.m b/check_dipfit_status.m
@@ -1,5 +1,8 @@
 function check_dipfit_status
 
+% NOHELPINFO
+% NON-UNIVERSAL
+
 ld = load(['D:\Dropbox\Dropbox\CURRENT PROJECTS\CUTTING\',...
     'DIPfit filled\ICAw_dipfit.mat']);
 ICAw = ld.ICAw;

diff --git a/comment_search.m b/comment_search.m
@@ -1,5 +1,7 @@
 function comm_events = comment_search(filename, evnts, varargin)
 
+% NOHELPINFO
+
 %% input checks
 if ~exist('evnts', 'var') || isempty(evnts)
     error(['Second argument of the function (',...

diff --git a/ICAbase_gui_main.fig → should be in a branch/ICAbase_gui_main.fig b/ICAbase_gui_main.fig → should be in a branch/ICAbase_gui_main.fig
diff --git a/ICAbase_gui_main.m → should be in a branch/ICAbase_gui_main.m b/ICAbase_gui_main.m → should be in a branch/ICAbase_gui_main.m