Merge pull request #2498 from AllenInstitute/ticket/1949

rename autorewarded to auto_rewarded in rewards table
AllenInstitute · Jul 18, 2022 · f955246 · f955246
2 parents 9fff87e + 9cdd044
commit f955246
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/allensdk/brain_observatory/behavior/behavior_session.py b/allensdk/brain_observatory/behavior/behavior_session.py
@@ -937,7 +937,7 @@ def rewards(self) -> pd.DataFrame:
                     0.007 if earned reward, 0.005 if auto reward.
                 timestamps: (float)
                     time in seconds
-                autorewarded: (bool)
+                auto_rewarded: (bool)
                     True if free reward was delivered for that trial.
                     Occurs during the first 5 trials of a session and
                     throughout as needed

diff --git a/allensdk/brain_observatory/behavior/data_objects/rewards.py b/allensdk/brain_observatory/behavior/data_objects/rewards.py
@@ -38,7 +38,7 @@ def from_stimulus_file(
         data = stimulus_file.data
 
         trial_df = pd.DataFrame(data["items"]["behavior"]["trial_log"])
-        rewards_dict = {"volume": [], "timestamps": [], "autorewarded": []}
+        rewards_dict = {"volume": [], "timestamps": [], "auto_rewarded": []}
         for idx, trial in trial_df.iterrows():
             rewards = trial["rewards"]
             # as i write this there can only ever be one reward per trial
@@ -47,7 +47,7 @@ def from_stimulus_file(
                 rewards_dict["timestamps"].append(
                     stimulus_timestamps.value[rewards[0][2]])
                 auto_rwrd = trial["trial_params"]["auto_reward"]
-                rewards_dict["autorewarded"].append(auto_rwrd)
+                rewards_dict["auto_rewarded"].append(auto_rwrd)
 
         df = pd.DataFrame(rewards_dict)
         return cls(rewards=df)
@@ -67,7 +67,7 @@ def from_nwb(cls, nwbfile: NWBFile) -> Optional["Rewards"]:
         df = pd.DataFrame({
                 'volume': volume,
                 'timestamps': time,
-                'autorewarded': autorewarded})
+                'auto_rewarded': autorewarded})
         return cls(rewards=df)
 
     def to_nwb(self, nwbfile: NWBFile) -> NWBFile:
@@ -87,7 +87,7 @@ def to_nwb(self, nwbfile: NWBFile) -> NWBFile:
 
         autorewarded_ts = TimeSeries(
             name='autorewarded',
-            data=self.value['autorewarded'].values,
+            data=self.value['auto_rewarded'].values,
             timestamps=reward_volume_ts.timestamps,
             unit='mL'
         )

diff --git a/allensdk/test/brain_observatory/behavior/data_objects/test_data/rewards.pkl b/allensdk/test/brain_observatory/behavior/data_objects/test_data/rewards.pkl
diff --git a/allensdk/test/brain_observatory/behavior/data_objects/test_rewards.py b/allensdk/test/brain_observatory/behavior/data_objects/test_rewards.py
@@ -89,7 +89,7 @@ def _create_dummy_stimulus_file():
 
         expected_dict = {'volume': [0.001, 0.002],
                          'timestamps': [0.04, 0.1],
-                         'autorewarded': [True, False]}
+                         'auto_rewarded': [True, False]}
         expected_df = pd.DataFrame(expected_dict)
         expected_df = expected_df
         assert expected_df.equals(rewards.value)

diff --git a/allensdk/test/brain_observatory/behavior/test_behavior_ophys_experiment.py b/allensdk/test/brain_observatory/behavior/test_behavior_ophys_experiment.py
@@ -77,7 +77,7 @@ def test_visbeh_ophys_data_set():
     assert len(data_set.licks) == 2421 and set(data_set.licks.columns) \
         == set(['timestamps', 'frame'])
     assert len(data_set.rewards) == 85 and set(data_set.rewards.columns) == \
-        set(['timestamps', 'volume', 'autorewarded'])
+        set(['timestamps', 'volume', 'auto_rewarded'])
     assert len(data_set.corrected_fluorescence_traces) == 258 and \
         set(data_set.corrected_fluorescence_traces.columns) == \
         set(['cell_roi_id', 'corrected_fluorescence'])