Add codespell to prevent typos: config, workflow and some typos fixed

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+# reference: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git,*.pdf,.codespellrc,*.svg
+ignore-words-list = sie,startet,oder,ist,als,alle,linke,ende,deines,manuell,egal,lief,relativ,zar,vor,wont,deine

.github/workflows/codespell.yml

@@ -0,0 +1,21 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+permissions:
+  contents: read
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

Task/Classes/al_display.m

@@ -14,7 +14,7 @@
 
         % General
         screensize % screen size
-        screensizePart % witdh and height of screen
+        screensizePart % width and height of screen
         distance2screen % participant distance to screen in mm
         screenWidthInMM % for degrees visual angle
         window % psychtoolbox window

Task/Classes/al_eyeTracker.m

@@ -46,7 +46,7 @@
         end
 
         function self = initializeEyeLink(self, taskParam, et_file_name_suffix)
-            % INITIALIZEEYELINK This function initialzes the eye-tracker
+            % INITIALIZEEYELINK This function initializes the eye-tracker
             %
             %   Input
             %       taskParam: Task-parameter-object instance

Task/Classes/al_gparam.m

@@ -23,7 +23,7 @@
 
         shieldMu % mean shield size        
         shieldMin % minimum angular shield size        
-        shieldMax % maximium angular shield size         
+        shieldMax % maximum angular shield size         
 
         trials % number of trials
         practTrials % number of practice trials

Task/Classes/al_strings.m

@@ -26,7 +26,7 @@
 
         function self = al_strings()
             % AL_STRINGS This function creates a strings object
-            % of classs al_strings
+            % of class al_strings
             %
             %   The initial values correspond to useful defaults that
             %   are often used across tasks.

Task/Classes/al_taskDataMain.m

@@ -716,7 +716,7 @@
         end
 
         function s = saveobj(self)
-            % SAVEOBJ This function tranlates data that we want to save
+            % SAVEOBJ This function translates data that we want to save
             % into a structure
             %
             %   Background:
@@ -849,7 +849,7 @@
 
             elseif isequal(self.taskType, 'infant')
 
-                % Todo carefull check what we need
+                % Todo careful check what we need
                 % when everything is implemented
 
                 s.group = self.group;

Task/Classes/al_trialflow.m

@@ -71,7 +71,7 @@
 
         % Whether or not tickmarks for current trial are used
         currentTickmarks
-            % show: standard tick makrs
+            % show: standard tick marks
             % workingMemory: 5 last outcomes
             % hide: no tick marks
 
@@ -141,7 +141,7 @@
 
         function self = al_trialflow()
             %AL_TRIALFLOW This function creates a trialflow object
-            % of classs al_trialflow
+            % of class al_trialflow
             %
             %   The initial values correspond to useful defaults that
             %   are often used across tasks.

Task/Functions/al_baselineArousal.m

@@ -37,7 +37,7 @@ function al_baselineArousal(taskParam, file_name_suffix)
         Eyelink('message', 'TRIALID %d', i);
     end
 
-    % Only send trigger on first interation
+    % Only send trigger on first iteration
     firstIteration = true;
 
     % Beginning of current color

Task/Functions/al_controlPredSpotKeyboard.m

@@ -12,7 +12,7 @@
 %       disableResponseThreshold: Optionally activate response time
 %                                 limit (if additionally specified in trialflow)
 %
-%   Ouptut
+%   Output
 %       breakLoop: Index response loop should be terminated
 %       taskParam: Task-parameter-object instance
 %       taskData: Task-data-object instance
@@ -98,7 +98,7 @@
 % Here, we separated both conditions for initRT and prediction control
 % to make sure that both would be completed even if button press was
 % extremely fast (which practically does not happen bc button press is
-% longer than one cyle in while loop).
+% longer than one cycle in while loop).
 
 % Second case: When other keys are pressed before space, update orange spot until space
 % is pressed

Task/Functions/al_drawCircle.m

@@ -19,7 +19,7 @@ function al_drawCircle(taskParam)
 % Generate circle
 Screen(taskParam.display.window.onScreen, 'FrameOval', taskParam.colors.circleCol, [zero(1) - rotRad, zero(2) - rotRad, zero(1) + rotRad, zero(2) + rotRad], [], circleWidth, []);
 
-% Mannually darawing two lines to check circle properties to compute number
+% Manually darawing two lines to check circle properties to compute number
 % of pixels for isoluminant background
 % rotRad = 140;
 % Screen(taskParam.display.window.onScreen, 'FrameOval', [0 0 0], [zero(1) - rotRad, zero(2) - rotRad, zero(1) + rotRad, zero(2) + rotRad], [], 1, []);

Task/Functions/al_keyboardLoop.m

@@ -12,7 +12,7 @@
 %       disableResponseThreshold: Optionally activate response time
 %                                 limit (if additionally specified in trialflow)
 %
-%   Ouptut
+%   Output
 %       taskData: Task-parameter-object instance
 %       taskParam: Task-data-object instance
 

Task/Functions/al_lineAndBack.m

@@ -1,5 +1,5 @@
 function al_lineAndBack(taskParam)
-%AL_LINEANDBACK This function draws the background for intructions in the cannon task
+%AL_LINEANDBACK This function draws the background for instructions in the cannon task
 %
 %   Input
 %       taskParam: Task-parameter-object instance

Task/Functions/al_minMaxNormalization.m

@@ -1,5 +1,5 @@
 function normalizedCoordinate = al_minMaxNormalization(currMouseCoord, minCoord, maxCoord)
-%AL_MINMAXNORMALIZATION This function perfoms min-max normalization for the
+%AL_MINMAXNORMALIZATION This function performs min-max normalization for the
 %joystick at the Donner MEG lab at UKE
 %
 %   Input

Task/Functions/al_sendTrigger.m

@@ -8,7 +8,7 @@
 %       trial: Current trial
 %       Tevent: Event type that gets triggered
 %
-%   Ouptut
+%   Output
 %       triggerID: Current trigger
 
 

Task/Functions/al_stressSlider.m

@@ -25,7 +25,7 @@
 scaleLengthPix = taskParam.display.screensize(4) / 1.5;
 scaleHLengthPix = scaleLengthPix / 2;
 
-% Coordiantes of the scale left and right ends
+% Coordinates of the scale left and right ends
 leftEnd = [taskParam.display.zero(1) - scaleHLengthPix taskParam.display.zero(2)];
 rightEnd = [taskParam.display.zero(1) + scaleHLengthPix taskParam.display.zero(2)];
 scaleLineCoords = [leftEnd' rightEnd'];
@@ -54,7 +54,7 @@
     [~, ~, numBoundsAll(i, :)] = DrawFormattedText(taskParam.display.window.onScreen, num2str(i), 0, 0, taskParam.colors.white);
 end
 
-% Width and height of the scale number text bounding boxs
+% Width and height of the scale number text bounding boxes
 numWidths = numBoundsAll(:, 3)';
 halfNumWidths = numWidths / 2;
 numHeights = [range([numBoundsAll(:, 2) numBoundsAll(:, 4)], 2)]';
@@ -64,7 +64,7 @@
 dim = 40;
 hDim = dim / 2;
 
-% The numbers are aligned to be directly under the relevent button (tops of
+% The numbers are aligned to be directly under the relevant button (tops of
 % their bounding boxes "numShiftDownPix" below the button y coordinate, and
 % aligned laterally such that the centre of the text bounding boxes aligned
 % with the x coordinate of the button

Task/Functions/al_tickMark.m

@@ -7,7 +7,7 @@
 %       type: Tick-mark type
 %
 %   Output
-%       tickLength: Length of tick mark to compute backgound RGB
+%       tickLength: Length of tick mark to compute background RGB
 %       col: Color to compute background RGB
 %
 % Todo: integrate in circle

Task/Functions/catstruct.m

@@ -62,7 +62,7 @@
 %                  (thanks to Tor Inge Birkenes).
 %                  Rephrased the help section as well.
 %   4.0 (dec 2013) fixed problem with unique due to version differences in
-%                  ML. Unique(...,'last') is no longer the deafult.
+%                  ML. Unique(...,'last') is no longer the default.
 %                  (thanks to Isabel P)
 
 %error(nargchk(1,Inf,nargin)) ;

Task/Functions/deg2rad.m

@@ -5,7 +5,7 @@
 % Keith Brady 18-08-2010
 %
 % Conversion function from Degrees to Radian.
-% an alterative form to the functions by Richard Medlock renamed as
+% an alternative form to the functions by Richard Medlock renamed as
 % suggested in the blog article 
 %
 % http://blogs.mathworks.com/pick/2009/11/27/degrees-and-radians/

Task/TaskVersions/Other/MagdeburgFMRI/al_MagdeburgFMRIInstructions.m

@@ -143,7 +143,7 @@ function al_MagdeburgFMRIInstructions(taskParam)
 taskData = taskData.taskData;
 taskData.initialTendency = nan(length(taskData.ID), 1);
 
-% Reset roation angle to starting location
+% Reset rotation angle to starting location
 taskParam.circle.rotAngle = 0;
 
 % Run task

Task/TaskVersions/Other/dresden/OutputTest.m

@@ -912,7 +912,7 @@ function testTaskOutput(testCase)
 %             % Set number of trials of control task
 %             controlTrials = 4;  % this is the new control version that we added to control for differences between groups
 %             
-%             % Number of practice trials - note that in "reversal" version this is muliplied by 2
+%             % Number of practice trials - note that in "reversal" version this is multiplied by 2
 %             practTrials = 2;
 %             
 %             % Number of trials to introduce the shield in the cover story
@@ -1012,7 +1012,7 @@ function testTaskOutput(testCase)
 %             timingParam = al_timing(timing_init);
 %             
 %             % ---------------------------------------------
-%             % Create object instance with srings to display
+%             % Create object instance with strings to display
 %             % ---------------------------------------------
 %             
 %             strings_init = al_stringsinit();

Task/TaskVersions/Other/dresden/RunDresdenVersion.m

@@ -94,7 +94,7 @@
 practiceTrialCriterionEstErr = 9;
 
 % Rotation radius
-rotationRad = 200; % this value should be differen on other computers
+rotationRad = 200; % this value should be different on other computers
 
 % Tickmark width
 tickWidth = 1;
@@ -205,7 +205,7 @@
 timingParam.fixedITI = 0.9;
 
 % This is a reference timestamp at the start of the experiment.
-% This is not equal to the first trial or so. So be carful when using
+% This is not equal to the first trial or so. So be careful when using
 % EEG or pupillometry and make sure the reference is specified as desired.
 timingParam.ref = GetSecs();
 

Task/TaskVersions/Other/dresden/al_dresdenInstructions.m

@@ -368,7 +368,7 @@ function al_dresdenInstructions(taskParam, whichPractice)
     end
 end
 
-% Confim that cannon ball was missed
+% Confirm that cannon ball was missed
 win = true;
 if isequal(whichPractice, 'main') || isequal(whichPractice, 'followCannon')
     txt = 'Weil Sie die Kanonenkugel verpasst haben, hätten Sie nichts verdient.';
@@ -520,7 +520,7 @@ function al_dresdenInstructions(taskParam, whichPractice)
 practData = load('CP_Noise.mat');
 taskData = practData.practData;
 
-% Reset roation angle to starting location
+% Reset rotation angle to starting location
 taskParam.circle.rotAngle = 0;
 
 % Practice session

Task/TaskVersions/Other/sleep/RunSleepVersion.m

@@ -15,7 +15,7 @@
 %       This function runs the sleep-study version of the cannon task.
 %       Subjects are sleep deprived and perform the task within
 %       a larger test battery. The version is shorter that usual
-%       and focuses on the most essential intructions.
+%       and focuses on the most essential instructions.
 %
 %   Testing
 %       To run the integration test, run "al_sleepIntegrationTest"
@@ -217,7 +217,7 @@
 timingParam = al_timing();
 
 % This is a reference timestamp at the start of the experiment.
-% This is not equal to the first trial or so. So be carful when using
+% This is not equal to the first trial or so. So be careful when using
 % EEG or pupillometry and make sure the reference is specified as desired.
 timingParam.ref = GetSecs();
 timingParam.jitterFixCrossOutcome = 0; % we did not use jitter here

Task/TaskVersions/Other/sleep/al_sleepInstructions.m

@@ -152,7 +152,7 @@ function al_sleepInstructions(taskParam)
     taskData = load('visCannonPracticeSleep.mat');
     taskData = taskData.taskData;
 
-    % Reset roation angle to starting location
+    % Reset rotation angle to starting location
     taskParam.circle.rotAngle = 0;
 
     % Run task

Task/TaskVersions/ResearchUnit/AsymmetricReward/RunAsymRewardVersion.m

@@ -239,7 +239,7 @@
 % timingParam.fixCrossOutcome = 0.5;
 
 % This is a reference timestamp at the start of the experiment.
-% This is not equal to the first trial or so. So be carful when using
+% This is not equal to the first trial or so. So be careful when using
 % EEG or pupillometry and make sure the reference is specified as desired.
 timingParam.ref = GetSecs();
 

Task/TaskVersions/ResearchUnit/AsymmetricReward/al_asymRewardInstructions.m

@@ -132,7 +132,7 @@ function al_asymRewardInstructions(taskParam)
     taskData = taskData.taskData;
     taskParam.trialflow.exp = 'practVis';
 
-    % Reset roation angle to starting location
+    % Reset rotation angle to starting location
     taskParam.circle.rotAngle = 0;
 
     % Run task

Task/TaskVersions/ResearchUnit/EEG/RunConfettiEEGVersion.m

@@ -118,7 +118,7 @@
 % customInstructions = config.customInstructions;
 % instructionText = config.instructionText;
 
-% More general paramters
+% More general parameters
 % ----------------------
 
 % Risk parameter: Precision of confetti average
@@ -291,7 +291,7 @@
 timingParam.jitterITI = 0.2;  
 
 % This is a reference timestamp at the start of the experiment.
-% This is not equal to the first trial or so. So be carful when using
+% This is not equal to the first trial or so. So be careful when using
 % EEG or pupillometry and make sure the reference is specified as desired.
 timingParam.ref = GetSecs();
 
@@ -523,7 +523,7 @@
 % -----------
 
 header = 'Ende des Versuchs!';
-txt = sprintf('Vielen Dank f�r Deine Teilnahme!\n\n\nDu hast insgesamt %.2f Euro gewonnen!', totWin);
+txt = sprintf('Vielen Dank f�r Deine Teilnahme!\n\n\nDu hast insgesamt %.2f Euro gewonnen!', totWin);
 feedback = true; % indicate that this is the instruction mode
 al_bigScreen(taskParam, header, txt, feedback, true);
 

Task/TaskVersions/ResearchUnit/EEG/al_confettiEEGConfigExample.m

@@ -4,7 +4,7 @@
 % function that runs the task.
 %
 % It is recommended that you create your own script with the local 
-% parameter settings so that you can re-use your settings.
+% parameter settings so that you can reuse your settings.
 
 % Create config structure
 config = struct();

Task/TaskVersions/ResearchUnit/EEG/al_confettiEEGLoop.m

@@ -3,7 +3,7 @@
 %
 %   Input
 %       taskParam: Task-parameter-object instance
-%       condtion: Condition type
+%       condition: Condition type
 %       taskData: Task-data-object instance
 %       trial: Number of trials
 %

Task/TaskVersions/ResearchUnit/Infant/RunInfantVersion.m

@@ -215,7 +215,7 @@
 timingParam.movingOutcome = 1.0;
 
 % This is a reference timestamp at the start of the experiment.
-% This is not equal to the first trial or so. So be carful when using
+% This is not equal to the first trial or so. So be careful when using
 % EEG or pupillometry and make sure the reference is specified as desired.
 timingParam.ref = GetSecs();
 

Task/TaskVersions/ResearchUnit/Infant/al_infantConfigExample.m

@@ -4,7 +4,7 @@
 % function that runs the task.
 %
 % It is recommended that you create your own script with the local 
-% parameter settings so that you can re-use your settings.
+% parameter settings so that you can reuse your settings.
 
 % Create config structure
 config = struct();