Change documentations

Python/hbayesdm/models/_bandit2arm_delta.py

@@ -95,13 +95,9 @@ def bandit2arm_delta(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "outcome".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "outcome".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bandit4arm2_kalman_filter.py

@@ -102,13 +102,9 @@ def bandit4arm2_kalman_filter(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "outcome".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "outcome".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bandit4arm_2par_lapse.py

@@ -98,13 +98,9 @@ def bandit4arm_2par_lapse(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bandit4arm_4par.py

@@ -100,13 +100,9 @@ def bandit4arm_4par(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bandit4arm_lapse.py

@@ -102,13 +102,9 @@ def bandit4arm_lapse(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bandit4arm_lapse_decay.py

@@ -104,13 +104,9 @@ def bandit4arm_lapse_decay(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bandit4arm_singleA_lapse.py

@@ -100,13 +100,9 @@ def bandit4arm_singleA_lapse(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_bart_par4.py

@@ -103,13 +103,9 @@ def bart_par4(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "pumps", "explosion".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "pumps", "explosion".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_cgt_cm.py

@@ -111,13 +111,9 @@ def cgt_cm(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "gamble_type", "percentage_staked", "trial_initial_points", "assessment_stage", "red_chosen", "n_red_boxes".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "gamble_type", "percentage_staked", "trial_initial_points", "assessment_stage", "red_chosen", "n_red_boxes".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_choiceRT_ddm.py

@@ -102,13 +102,9 @@ def choiceRT_ddm(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "RT".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "RT".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_choiceRT_ddm_single.py

@@ -102,13 +102,9 @@ def choiceRT_ddm_single(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "RT".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "RT".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_cra_exp.py

@@ -105,13 +105,9 @@ def cra_exp(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "prob", "ambig", "reward_var", "reward_fix", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "prob", "ambig", "reward_var", "reward_fix", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_cra_linear.py

@@ -105,13 +105,9 @@ def cra_linear(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "prob", "ambig", "reward_var", "reward_fix", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "prob", "ambig", "reward_var", "reward_fix", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_dbdm_prob_weight.py

@@ -110,13 +110,9 @@ def dbdm_prob_weight(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "opt1hprob", "opt2hprob", "opt1hval", "opt1lval", "opt2hval", "opt2lval", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "opt1hprob", "opt2hprob", "opt1hval", "opt1lval", "opt2hval", "opt2lval", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_dd_cs.py

@@ -102,13 +102,9 @@ def dd_cs(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_dd_cs_single.py

@@ -102,13 +102,9 @@ def dd_cs_single(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_dd_exp.py

@@ -100,13 +100,9 @@ def dd_exp(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_dd_hyperbolic.py

@@ -100,13 +100,9 @@ def dd_hyperbolic(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_dd_hyperbolic_single.py

@@ -100,13 +100,9 @@ def dd_hyperbolic_single(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_gng_m1.py

@@ -101,13 +101,9 @@ def gng_m1(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_gng_m2.py

@@ -103,13 +103,9 @@ def gng_m2(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_gng_m3.py

@@ -106,13 +106,9 @@ def gng_m3(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_gng_m4.py

@@ -108,13 +108,9 @@ def gng_m4(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "cue", "keyPressed", "outcome".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_igt_orl.py

@@ -102,13 +102,9 @@ def igt_orl(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.

Python/hbayesdm/models/_igt_pvl_decay.py

@@ -100,13 +100,9 @@ def igt_pvl_decay(
 
     Parameters
     ----------
-    example
-        Whether to use the example data provided by hBayesDM.
-    datafile
-        Path for a TSV file containing the data to be modeled.
-        Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     data
-        Pandas DataFrame object holding the data to be modeled.
+        Data to be modeled. It should be given as a Pandas DataFrame object,
+        a filepath for a data file, or ``"example"`` for example data.
         Data columns should be labeled as: "subjID", "choice", "gain", "loss".
     niter
         Number of iterations, including warm-up. Defaults to 4000.