Documentation on dataframe columns names and meanings

[rachelstephlee]

Notes for myself....

df_sess

finished_trials: all trials that are finished (i.e. not ignored)
total_trials: all trials that mouse did
reward_trials: all rewarded trials

df_trials

earned_reward = rewards earned from the trials
extra_reward = manual reward or auto reward, any reward given to address low motivation or strong bias.
-> manual reward = trainer decides to give animal reward based on human judgement.
-> auto reward = the behavior gui decides to give animals water.

** note: when Sue calculated RPE's, she removed sessions with 'extra_reward` or trimmed off beginning/end of those sessions (or took half of them only)

all columns:
['trial', 'choice', 'rewarded_historyL', 'rewarded_historyR',
'bait_left', 'bait_right', 'base_reward_probability_sum',
'reward_probabilityL', 'reward_probabilityR',
'reward_random_number_left', 'reward_random_number_right',
'left_valve_open_time', 'right_valve_open_time', 'block_beta',
'block_min', 'block_max', 'min_reward_each_block', 'delay_beta',
'delay_min', 'delay_max', 'delay_duration', 'ITI_beta', 'ITI_min',
'ITI_max', 'ITI_duration', 'response_duration',
'reward_consumption_duration', 'auto_waterL', 'auto_waterR',
'laser_on_trial', 'laser_wavelength', 'laser_location', 'laser_power',
'laser_duration', 'laser_condition', 'laser_condition_probability',
'laser_start', 'laser_start_offset', 'laser_end', 'laser_end_offset',
'laser_protocol', 'laser_frequency', 'laser_rampingdown',
'laser_pulse_duration', 'auto_train_engaged',
'auto_train_curriculum_name', 'auto_train_curriculum_version',
'auto_train_curriculum_schema_version', 'auto_train_stage',
'auto_train_stage_overridden', 'lickspout_position_x',
'lickspout_position_y', 'lickspout_position_z', 'reward_size_left',
'reward_size_right', 'ses_idx', 'start_time_in_session',
'start_time_in_trial', 'stop_time_in_session', 'stop_time_in_trial',
'delay_start_time_in_session', 'delay_start_time_in_trial',
'goCue_start_time_in_session', 'goCue_start_time_in_trial',
'reward_outcome_time_in_session', 'reward_outcome_time_in_trial',
'goCue_start_time_raw', 'reward_time_in_session',
'reward_time_in_trial', 'choice_time_in_session',
'choice_time_in_trial', 'earned_reward', 'extra_reward',
'lickspout_position_y1', 'lickspout_position_y2', 'choice_name',
'model_name', 'L_prob', 'R_prob', 'L_value', 'R_value', 'L_kernel',
'R_kernel'],