documentation cleanup

Author: Barafat2

MultiTaskBattery/task_blocks.py

@@ -991,95 +991,6 @@ def run_trial(self, trial):
         self.display_trial_feedback(trial['display_trial_feedback'], trial['correct']== 1)
 
         return trial
-    
-class Sencoding(Task):
-    def __init__(self, info, screen, ttl_clock, const, subj_id):
-        super().__init__(info, screen, ttl_clock, const, subj_id)
-
-    def display_instructions(self):
-        self.instruction_text = f'{self.descriptive_name} Task \n\nListen to the following sentences attentively.'
-        instr_visual = visual.TextStim(self.window, text=self.instruction_text, height=self.const.instruction_text_height, color=[-1, -1, -1])
-        instr_visual.draw()
-        self.window.flip()
-
-    def run_trial(self, trial):
-        """ Run a single trial of the task. """
-
-        self.screen.fixation_cross()
-
-        # Load and play audio stimulus for the current trial
-        audio_path = self.const.stim_dir / self.name / trial['stim']
-        audio_stim = sound.Sound(str(audio_path))
-        audio_stim.play()
-
-        # wait for trial duration
-        self.ttl_clock.wait_until(self.ttl_clock.get_time() + trial['trial_dur'])
-
-        # display trial feedback
-        self.display_trial_feedback(give_feedback= trial['display_trial_feedback'], correct_response = None)
-
-        return trial
-    
-class SencodingProbe(Task):
-    def __init__(self, info, screen, ttl_clock, const, subj_id):
-        super().__init__(info, screen, ttl_clock, const, subj_id)
-        self.feedback_type = 'acc+rt'
-
-    def init_task(self):
-        """
-        Initialize task - default is to read the target information into the trial_info dataframe
-        """
-        self.trial_info = pd.read_csv(self.const.task_dir / self.name / self.task_file, sep='\t')
-        self.corr_key = [self.trial_info['first_key'].iloc[0],self.trial_info['second_key'].iloc[0]]
-
-        
-    def display_instructions(self):
-        """
-        displays the instruction for the task
-        """
-        str1 = f"You will read sentences and decide which completion is closer to a sentence you heard in the last run"
-        self.instruction_text = f"{self.descriptive_name} Task\n\n {str1}"
-        instr_visual = visual.TextStim(self.window, text=self.instruction_text, height=self.const.instruction_text_height, color=[-1, -1, -1])
-        instr_visual.draw()
-        self.window.flip()
-
-    def run_trial(self, trial):
-        """ Runs a single trial of the Theory of Mind task """
-
-        event.clearEvents()
-
-        # Display story
-        str1 = trial['stem']
-        str2 = trial['option_1']
-        str3 = trial['option_2']
-
-        story_stim = visual.TextStim(self.window, text=f'Stem:{str1} \n\n A: {str2} \n B:{str3}', alignHoriz='center', wrapWidth=25, pos=(0.0, 0.0), color=(-1, -1, -1), units='deg', height= 1.25)
-        story_stim.draw()
-        self.window.flip()
-
-       # wait until story duration
-        # self.ttl_clock.wait_until(self.ttl_clock.get_time() + trial['trial_dur'] + trial['iti_dur'])
-
-
-        # collect responses 0: no response 1-4: key pressed
-        trial['response'],trial['rt'] = self.wait_response(self.ttl_clock.get_time(), trial['trial_dur'])
-
-        if trial['answer'] == trial['option_1']:
-            trial['trial_type'] = 0
-        elif trial['answer'] == trial['option_2']:
-            trial['trial_type'] = 1
-        else:
-            print('answer doesnt match either option check if there is lagging space')
-            
-        trial['correct'] = (trial['response'] == self.corr_key[trial['trial_type']])
-
-        # display trial feedback
-        self.display_trial_feedback(trial['display_trial_feedback'], trial['correct'])
-
-        # Flush any keys in buffer
-        event.clearEvents()
-
-        return trial
 
 class FlexionExtension(Task):
     """

MultiTaskBattery/task_table.tsv

@@ -15,8 +15,6 @@ oddball	OddBall	oddball	odbal		"Functional specificity for high-level linguistic
 demand_grid	DemandGrid	grid	dmgrd			
 finger_sequence	FingerSequence	finger_sequence	fingseq			
 flexion_extension	FlexionExtension	toe	flexexten	alternating periods of flexing/extending toes		
-sencoding	Sencoding	sentence	sencod			
-sencoding_probe	SencodingProbe	sentence_probe	sencodeprob			
 semantic_prediction	SemanticPrediction	complete	sempred	"sentence presented, participants decide if last word makes sense."		
 visual_search	VisualSearch	search	visrchsml	"geometric shapes presented on screen, participants must identify if 'L' is present."		
 rmet	RMET	eyes	rmet	"pictures of faces with different emotions presented (eyes only) along with four attribute words, participants must identify which attribute describes person best."	"Kim, H.A. et al. (2024) ‘Multiracial Reading the Mind in the Eyes Test (MRMET): An inclusive version of an influential measure’, Behavior Research Methods. Revised from Baron-Cohen, Wheelwright, Hill, Raste, & Plumb, 2001"	"age, emotion"

README.md

@@ -1,9 +1,38 @@
-Multi Task Battery 
+# 🧠 Multi Task Battery (MTB)
 ============
 
+A flexible Python toolbox for running multi-domain cognitive and motor tasks during fMRI sessions — all within a single scanning run. Built on [PsychoPy](https://www.psychopy.org/)
+
+
 This project runs multi-task batteries developed by the diedrichsenlab.
 #### Authors: Diedrichsenlab (Bassel Arafat, Ince Husain, Caroline Nettekoven, Ladan Shahshahani, Suzanne Witt, Maedbh King, Jorn Diedrichsen)
 
 
-Full documentation can be found at: https://multitaskbattery.readthedocs.io/
 
+## 📓 Documentation
+
+Full documentation is hosted at:  
+📘 https://multitaskbattery.readthedocs.io/
+
+Covers:
+- Installation and setup
+- Task and run configuration
+- Data output and extensions
+
+---
+
+## 📄 License
+
+MIT License © 2024 Joern Diedrichsen
+
+---
+
+## 🤛 Contributing
+
+Open to issues and pull requests. If you use MTB in your research, we'd love to hear from you.
+
+---
+
+## 🧠 Citation
+
+_A publication describing MTB is forthcoming._ Please cite this GitHub repository and relevant task sources.