Merge pull request #52 from DevComPsy/feature/datasets

feature/datasets - add scavenger example dataset

Author: lenarddome

cpm/datasets/base.py

@@ -47,28 +47,42 @@ def load_bandit_data():
     -----
     The dataset will include the following columns:
 
-        - `ppt`: the participant number.
-        - `trial`: the trial number.
-        - `arm_left`: the stimulus presented on the left side.
-        - `arm_right`: the stimulus presented on the right side.
+        - `index`: variable to identify each row - this variable is clutter.
+        - `left`: the stimulus presented on the left side.
+        - `right`: the stimulus presented on the right side.
         - `reward_left`: the reward received when the left stimulus is selected.
         - `reward_right`: the reward received when the right stimulus is selected.
-        - `response`: the response of the participant (1 for right, 0 for left).
-        - `feedback`: the feedback received by the participant (1 for reward, 0 for no reward).
+        - `ppt`: the participant number.
+        - `responses`: the response of the participant (1 for right, 0 for left).
     """
     return load_csv("bandit_small.csv")
 
 
-# def load_another_dataset():
-#     """
-#     Load another dataset from a CSV file.
+def load_risky_choices():
+    """
+    Load the risky choices dataset from a CSV file.
+
+    Returns
+    -------
+    pd.DataFrame
+        A pandas DataFrame containing the risky choices data.
+
+    Examples
+    --------
+    >>> data = load_risky_choices()
+    >>> print(data.head())
 
-#     Returns
-#     -------
-#     pd.DataFrame
-#         A pandas DataFrame containing the data from the CSV file.
-#     """
-#     return load_csv("another_dataset.csv")
+    Notes
+    -----
+    The dataset will include the following columns:
 
+        - `ppt`: the participant number.
+        - `safe_magnitudes`: the magnitudes of the safe option.
+        - `risky_magnitudes_1`, `risky_magnitudes_2`: the magnitudes of the risky options.
+        - `safe_prob`: the probability of the safe option.
+        - `risky_prob_1`, `risky_prob_2`: the probabilities of the risky options.
+        - `choice`: the choice of the participant (1 for risky, 0 for safe).
+        - `chose_left`: whether the participant chose the left option (1 for left, 0 for right).
 
-# Add more functions for other CSV files as needed
+    """
+    return load_csv("risky_choices.csv")

cpm/datasets/data/risky_choices.csv

@@ -0,0 +1,301 @@
+ppt,safe_magnitudes,risky_magnitudes_1,risky_magnitudes_2,choice,chose_left,safe_prob,risky_prob_1,risky_prob_2
+593,-45,-100,0,0,0,1,0.5,0.5
+593,-55,-122,0,0,1,1,0.5,0.5
+593,-30,-51,0,1,0,1,0.5,0.5
+593,55,53,0,0,1,1,0.5,0.5
+593,-35,-64,0,1,0,1,0.5,0.5
+593,55,79,0,0,0,1,0.5,0.5
+593,55,124,0,1,1,1,0.5,0.5
+593,35,58,0,1,0,1,0.5,0.5
+593,30,220,0,1,1,1,0.5,0.5
+593,-55,-56,0,1,1,1,0.5,0.5
+593,-55,-68,0,1,1,1,0.5,0.5
+593,-35,-94,0,0,1,1,0.5,0.5
+593,-35,-112,0,0,0,1,0.5,0.5
+593,35,98,0,1,1,1,0.5,0.5
+593,-45,-110,0,0,0,1,0.5,0.5
+593,-45,-90,0,1,1,1,0.5,0.5
+593,55,51,0,0,0,1,0.5,0.5
+593,-55,-220,0,0,1,1,0.5,0.5
+593,55,113,0,1,1,1,0.5,0.5
+593,30,74,0,1,0,1,0.5,0.5
+593,35,98,0,1,1,1,0.5,0.5
+593,-35,-68,0,1,0,1,0.5,0.5
+593,-30,-120,0,0,0,1,0.5,0.5
+593,-35,-98,0,0,0,1,0.5,0.5
+593,-30,-60,0,1,0,1,0.5,0.5
+593,35,100,0,1,1,1,0.5,0.5
+593,-45,-49,0,1,0,1,0.5,0.5
+593,30,107,0,1,0,1,0.5,0.5
+593,35,87,0,1,1,1,0.5,0.5
+593,55,107,0,0,1,1,0.5,0.5
+593,-45,-132,0,0,0,1,0.5,0.5
+593,45,180,0,1,0,1,0.5,0.5
+593,30,100,0,1,0,1,0.5,0.5
+593,35,64,0,1,1,1,0.5,0.5
+593,30,49,0,1,1,1,0.5,0.5
+593,-35,-66,0,1,1,1,0.5,0.5
+593,55,66,0,0,0,1,0.5,0.5
+593,-35,-84,0,0,0,1,0.5,0.5
+593,35,107,0,1,1,1,0.5,0.5
+593,-35,-79,0,0,1,1,0.5,0.5
+593,-45,-84,0,1,0,1,0.5,0.5
+593,-55,-95,0,1,0,1,0.5,0.5
+593,-30,-53,0,1,1,1,0.5,0.5
+593,-45,-120,0,0,1,1,0.5,0.5
+593,35,85,0,1,1,1,0.5,0.5
+593,35,58,0,0,0,1,0.5,0.5
+593,-35,-66,0,1,1,1,0.5,0.5
+593,-30,-148,0,0,1,1,0.5,0.5
+593,45,102,0,1,1,1,0.5,0.5
+593,35,84,0,1,0,1,0.5,0.5
+593,55,98,0,0,0,1,0.5,0.5
+593,55,180,0,1,0,1,0.5,0.5
+593,55,108,0,0,0,1,0.5,0.5
+593,-35,-148,0,0,0,1,0.5,0.5
+593,-45,-117,0,0,0,1,0.5,0.5
+593,45,60,0,0,1,1,0.5,0.5
+593,35,66,0,0,0,1,0.5,0.5
+593,-35,-98,0,0,0,1,0.5,0.5
+593,45,124,0,1,1,1,0.5,0.5
+593,-55,-93,0,1,0,1,0.5,0.5
+595,55,74,0,0,0,1,0.5,0.5
+595,-55,-112,0,0,0,1,0.5,0.5
+595,-30,-97,0,1,1,1,0.5,0.5
+595,35,53,0,0,1,1,0.5,0.5
+595,30,180,0,1,1,1,0.5,0.5
+595,30,93,0,1,1,1,0.5,0.5
+595,30,58,0,0,1,1,0.5,0.5
+595,-30,-82,0,0,1,1,0.5,0.5
+595,30,112,0,1,1,1,0.5,0.5
+595,30,117,0,1,1,1,0.5,0.5
+595,-45,-58,0,1,1,1,0.5,0.5
+595,45,107,0,1,0,1,0.5,0.5
+595,30,56,0,0,1,1,0.5,0.5
+595,55,79,0,0,1,1,0.5,0.5
+595,55,57,0,0,1,1,0.5,0.5
+595,45,66,0,0,0,1,0.5,0.5
+595,-30,-180,0,0,0,1,0.5,0.5
+595,-55,-72,0,1,0,1,0.5,0.5
+595,-55,-117,0,0,0,1,0.5,0.5
+595,-30,-132,0,0,0,1,0.5,0.5
+595,35,94,0,1,1,1,0.5,0.5
+595,-45,-79,0,1,0,1,0.5,0.5
+595,-45,-74,0,1,0,1,0.5,0.5
+595,30,82,0,1,1,1,0.5,0.5
+595,-55,-140,0,0,1,1,0.5,0.5
+595,45,74,0,0,1,1,0.5,0.5
+595,55,87,0,0,0,1,0.5,0.5
+595,-30,-95,0,0,0,1,0.5,0.5
+595,45,56,0,0,1,1,0.5,0.5
+595,35,98,0,1,1,1,0.5,0.5
+595,55,220,0,1,0,1,0.5,0.5
+595,55,180,0,1,0,1,0.5,0.5
+595,-30,-76,0,0,0,1,0.5,0.5
+595,35,68,0,0,0,1,0.5,0.5
+595,-45,-102,0,0,0,1,0.5,0.5
+595,-30,-84,0,0,0,1,0.5,0.5
+595,-30,-58,0,1,0,1,0.5,0.5
+595,-55,-60,0,1,0,1,0.5,0.5
+595,45,94,0,1,0,1,0.5,0.5
+595,-55,-176,0,0,0,1,0.5,0.5
+595,-45,-74,0,1,1,1,0.5,0.5
+595,-35,-120,0,0,1,1,0.5,0.5
+595,35,70,0,0,0,1,0.5,0.5
+595,-45,-148,0,0,0,1,0.5,0.5
+595,-30,-76,0,0,0,1,0.5,0.5
+595,55,82,0,0,1,1,0.5,0.5
+595,-45,-55,0,0,0,1,0.5,0.5
+595,-30,-140,0,0,1,1,0.5,0.5
+595,45,87,0,1,0,1,0.5,0.5
+595,-30,-132,0,0,1,1,0.5,0.5
+595,-45,-87,0,1,1,1,0.5,0.5
+595,30,124,0,1,1,1,0.5,0.5
+595,-45,-74,0,1,0,1,0.5,0.5
+595,55,103,0,0,1,1,0.5,0.5
+595,35,94,0,1,0,1,0.5,0.5
+595,-35,-55,0,1,0,1,0.5,0.5
+595,-30,-72,0,0,0,1,0.5,0.5
+595,45,124,0,1,1,1,0.5,0.5
+595,45,140,0,1,1,1,0.5,0.5
+595,-45,-90,0,1,0,1,0.5,0.5
+597,30,85,0,0,1,1,0.5,0.5
+597,-30,-56,0,1,1,1,0.5,0.5
+597,55,144,0,1,1,1,0.5,0.5
+597,45,64,0,1,0,1,0.5,0.5
+597,-55,-93,0,1,1,1,0.5,0.5
+597,-55,-72,0,1,0,1,0.5,0.5
+597,-45,-98,0,1,1,1,0.5,0.5
+597,30,180,0,0,0,1,0.5,0.5
+597,-30,-108,0,0,1,1,0.5,0.5
+597,55,60,0,0,0,1,0.5,0.5
+597,45,64,0,0,0,1,0.5,0.5
+597,55,90,0,1,0,1,0.5,0.5
+597,55,110,0,0,0,1,0.5,0.5
+597,-30,-66,0,1,1,1,0.5,0.5
+597,45,55,0,0,0,1,0.5,0.5
+597,-55,-117,0,0,1,1,0.5,0.5
+597,30,84,0,1,0,1,0.5,0.5
+597,-45,-57,0,1,0,1,0.5,0.5
+597,30,66,0,1,0,1,0.5,0.5
+597,-30,-122,0,0,0,1,0.5,0.5
+597,35,100,0,1,0,1,0.5,0.5
+597,-30,-112,0,0,0,1,0.5,0.5
+597,-30,-97,0,0,1,1,0.5,0.5
+597,-55,-58,0,1,1,1,0.5,0.5
+597,-55,-79,0,1,0,1,0.5,0.5
+597,30,103,0,1,1,1,0.5,0.5
+597,-45,-103,0,1,0,1,0.5,0.5
+597,-30,-96,0,0,1,1,0.5,0.5
+597,-35,-74,0,0,1,1,0.5,0.5
+597,-55,-56,0,1,0,1,0.5,0.5
+597,30,93,0,1,0,1,0.5,0.5
+597,55,120,0,1,1,1,0.5,0.5
+597,45,62,0,0,1,1,0.5,0.5
+597,55,81,0,0,1,1,0.5,0.5
+597,-30,-76,0,1,1,1,0.5,0.5
+597,45,107,0,1,1,1,0.5,0.5
+597,-55,-148,0,0,1,1,0.5,0.5
+597,55,68,0,0,1,1,0.5,0.5
+597,-35,-180,0,1,1,1,0.5,0.5
+597,45,110,0,1,1,1,0.5,0.5
+597,-55,-176,0,0,1,1,0.5,0.5
+597,55,120,0,1,1,1,0.5,0.5
+597,35,102,0,1,0,1,0.5,0.5
+597,45,53,0,0,0,1,0.5,0.5
+597,-45,-57,0,1,0,1,0.5,0.5
+597,35,74,0,1,1,1,0.5,0.5
+597,55,96,0,0,0,1,0.5,0.5
+597,45,74,0,0,1,1,0.5,0.5
+597,45,220,0,1,0,1,0.5,0.5
+597,-30,-87,0,0,1,1,0.5,0.5
+597,-30,-55,0,0,1,1,0.5,0.5
+597,-45,-220,0,0,1,1,0.5,0.5
+597,-30,-94,0,1,1,1,0.5,0.5
+597,45,81,0,1,1,1,0.5,0.5
+597,45,180,0,1,1,1,0.5,0.5
+597,-35,-140,0,0,0,1,0.5,0.5
+597,35,79,0,1,0,1,0.5,0.5
+597,-55,-76,0,1,1,1,0.5,0.5
+597,-45,-74,0,1,1,1,0.5,0.5
+597,-55,-76,0,1,0,1,0.5,0.5
+614,-35,-95,0,0,1,1,0.5,0.5
+614,30,82,0,0,1,1,0.5,0.5
+614,45,117,0,0,0,1,0.5,0.5
+614,-35,-180,0,1,1,1,0.5,0.5
+614,45,124,0,0,0,1,0.5,0.5
+614,-45,-117,0,0,0,1,0.5,0.5
+614,35,220,0,1,0,1,0.5,0.5
+614,55,55,0,0,0,1,0.5,0.5
+614,55,62,0,0,1,1,0.5,0.5
+614,35,70,0,0,0,1,0.5,0.5
+614,30,93,0,0,1,1,0.5,0.5
+614,35,62,0,0,1,1,0.5,0.5
+614,-55,-49,0,1,0,1,0.5,0.5
+614,-35,-84,0,0,0,1,0.5,0.5
+614,-45,-53,0,1,1,1,0.5,0.5
+614,30,100,0,1,1,1,0.5,0.5
+614,-30,-220,0,1,0,1,0.5,0.5
+614,45,180,0,0,0,1,0.5,0.5
+614,-45,-56,0,1,0,1,0.5,0.5
+614,-45,-117,0,0,1,1,0.5,0.5
+614,-35,-49,0,1,1,1,0.5,0.5
+614,-30,-148,0,0,1,1,0.5,0.5
+614,30,108,0,1,1,1,0.5,0.5
+614,30,87,0,0,0,1,0.5,0.5
+614,-55,-66,0,1,1,1,0.5,0.5
+614,-30,-76,0,0,0,1,0.5,0.5
+614,35,100,0,0,0,1,0.5,0.5
+614,-35,-180,0,0,0,1,0.5,0.5
+614,-30,-64,0,0,1,1,0.5,0.5
+614,-55,-76,0,1,1,1,0.5,0.5
+614,35,112,0,1,0,1,0.5,0.5
+614,35,79,0,0,0,1,0.5,0.5
+614,45,56,0,0,1,1,0.5,0.5
+614,45,96,0,0,1,1,0.5,0.5
+614,45,72,0,0,1,1,0.5,0.5
+614,-30,-79,0,0,1,1,0.5,0.5
+614,-35,-82,0,1,1,1,0.5,0.5
+614,45,108,0,0,0,1,0.5,0.5
+614,30,57,0,0,1,1,0.5,0.5
+614,-35,-74,0,0,1,1,0.5,0.5
+614,45,56,0,0,1,1,0.5,0.5
+614,-30,-110,0,0,0,1,0.5,0.5
+614,30,140,0,0,1,1,0.5,0.5
+614,-55,-66,0,0,1,1,0.5,0.5
+614,45,49,0,0,0,1,0.5,0.5
+614,-45,-87,0,0,1,1,0.5,0.5
+614,30,60,0,0,0,1,0.5,0.5
+614,-55,-176,0,0,1,1,0.5,0.5
+614,-30,-57,0,0,1,1,0.5,0.5
+614,35,96,0,0,0,1,0.5,0.5
+614,45,102,0,0,0,1,0.5,0.5
+614,30,120,0,0,1,1,0.5,0.5
+614,-30,-98,0,0,0,1,0.5,0.5
+614,-30,-66,0,0,1,1,0.5,0.5
+614,-30,-85,0,0,1,1,0.5,0.5
+614,55,140,0,0,0,1,0.5,0.5
+614,-35,-124,0,0,1,1,0.5,0.5
+614,-30,-176,0,0,1,1,0.5,0.5
+614,-45,-94,0,0,0,1,0.5,0.5
+614,55,85,0,0,1,1,0.5,0.5
+616,-30,-220,0,1,1,1,0.5,0.5
+616,55,180,0,1,0,1,0.5,0.5
+616,-35,-108,0,0,0,1,0.5,0.5
+616,45,98,0,1,1,1,0.5,0.5
+616,-35,-102,0,0,0,1,0.5,0.5
+616,55,68,0,0,1,1,0.5,0.5
+616,-55,-49,0,1,0,1,0.5,0.5
+616,-35,-113,0,1,1,1,0.5,0.5
+616,35,112,0,1,1,1,0.5,0.5
+616,35,81,0,0,1,1,0.5,0.5
+616,30,98,0,1,0,1,0.5,0.5
+616,-30,-56,0,1,0,1,0.5,0.5
+616,30,110,0,1,0,1,0.5,0.5
+616,55,144,0,0,1,1,0.5,0.5
+616,35,64,0,0,0,1,0.5,0.5
+616,-45,-70,0,1,1,1,0.5,0.5
+616,-45,-93,0,0,0,1,0.5,0.5
+616,-45,-64,0,1,1,1,0.5,0.5
+616,-55,-180,0,0,0,1,0.5,0.5
+616,30,117,0,1,0,1,0.5,0.5
+616,55,112,0,1,1,1,0.5,0.5
+616,35,85,0,0,0,1,0.5,0.5
+616,-45,-100,0,1,0,1,0.5,0.5
+616,-55,-93,0,0,1,1,0.5,0.5
+616,-45,-66,0,0,0,1,0.5,0.5
+616,55,56,0,0,0,1,0.5,0.5
+616,-35,-124,0,0,1,1,0.5,0.5
+616,55,132,0,0,0,1,0.5,0.5
+616,-30,-72,0,0,1,1,0.5,0.5
+616,-45,-113,0,0,1,1,0.5,0.5
+616,55,55,0,0,0,1,0.5,0.5
+616,30,70,0,0,0,1,0.5,0.5
+616,-55,-117,0,0,1,1,0.5,0.5
+616,-55,-113,0,0,0,1,0.5,0.5
+616,35,51,0,0,0,1,0.5,0.5
+616,-35,-82,0,0,1,1,0.5,0.5
+616,30,98,0,0,0,1,0.5,0.5
+616,-35,-72,0,0,1,1,0.5,0.5
+616,-55,-117,0,0,1,1,0.5,0.5
+616,-30,-100,0,0,0,1,0.5,0.5
+616,-35,-100,0,0,0,1,0.5,0.5
+616,-55,-87,0,0,0,1,0.5,0.5
+616,30,81,0,1,0,1,0.5,0.5
+616,30,90,0,1,1,1,0.5,0.5
+616,30,85,0,1,0,1,0.5,0.5
+616,-35,-93,0,0,0,1,0.5,0.5
+616,-55,-97,0,1,1,1,0.5,0.5
+616,-35,-51,0,0,0,1,0.5,0.5
+616,35,98,0,1,1,1,0.5,0.5
+616,55,90,0,1,1,1,0.5,0.5
+616,45,124,0,1,0,1,0.5,0.5
+616,-45,-56,0,0,0,1,0.5,0.5
+616,30,180,0,1,0,1,0.5,0.5
+616,45,53,0,1,0,1,0.5,0.5
+616,45,53,0,1,1,1,0.5,0.5
+616,55,58,0,0,0,1,0.5,0.5
+616,30,103,0,1,1,1,0.5,0.5
+616,-30,-107,0,0,1,1,0.5,0.5
+616,-30,-58,0,0,0,1,0.5,0.5
+616,30,68,0,1,1,1,0.5,0.5