diff --git a/Python/hbayesdm/models/_bandit2arm_delta.py b/Python/hbayesdm/models/_bandit2arm_delta.py index 9f798a67..3504d2f5 100644 --- a/Python/hbayesdm/models/_bandit2arm_delta.py +++ b/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. diff --git a/Python/hbayesdm/models/_bandit4arm2_kalman_filter.py b/Python/hbayesdm/models/_bandit4arm2_kalman_filter.py index 9fbf2696..f84421ea 100644 --- a/Python/hbayesdm/models/_bandit4arm2_kalman_filter.py +++ b/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. diff --git a/Python/hbayesdm/models/_bandit4arm_2par_lapse.py b/Python/hbayesdm/models/_bandit4arm_2par_lapse.py index 630feeb6..1caec205 100644 --- a/Python/hbayesdm/models/_bandit4arm_2par_lapse.py +++ b/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. diff --git a/Python/hbayesdm/models/_bandit4arm_4par.py b/Python/hbayesdm/models/_bandit4arm_4par.py index e947485a..617c8f96 100644 --- a/Python/hbayesdm/models/_bandit4arm_4par.py +++ b/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. diff --git a/Python/hbayesdm/models/_bandit4arm_lapse.py b/Python/hbayesdm/models/_bandit4arm_lapse.py index 4b825f4d..157f4b58 100644 --- a/Python/hbayesdm/models/_bandit4arm_lapse.py +++ b/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. diff --git a/Python/hbayesdm/models/_bandit4arm_lapse_decay.py b/Python/hbayesdm/models/_bandit4arm_lapse_decay.py index d81887e2..1f5b71ff 100644 --- a/Python/hbayesdm/models/_bandit4arm_lapse_decay.py +++ b/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. diff --git a/Python/hbayesdm/models/_bandit4arm_singleA_lapse.py b/Python/hbayesdm/models/_bandit4arm_singleA_lapse.py index 4a8aae00..55da5cae 100644 --- a/Python/hbayesdm/models/_bandit4arm_singleA_lapse.py +++ b/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. diff --git a/Python/hbayesdm/models/_bart_par4.py b/Python/hbayesdm/models/_bart_par4.py index aca370e4..f7600521 100644 --- a/Python/hbayesdm/models/_bart_par4.py +++ b/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. diff --git a/Python/hbayesdm/models/_cgt_cm.py b/Python/hbayesdm/models/_cgt_cm.py index 239b19d7..01a5bc8a 100644 --- a/Python/hbayesdm/models/_cgt_cm.py +++ b/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. diff --git a/Python/hbayesdm/models/_choiceRT_ddm.py b/Python/hbayesdm/models/_choiceRT_ddm.py index d889bd51..07b93f10 100644 --- a/Python/hbayesdm/models/_choiceRT_ddm.py +++ b/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. diff --git a/Python/hbayesdm/models/_choiceRT_ddm_single.py b/Python/hbayesdm/models/_choiceRT_ddm_single.py index bdb9da03..2fdfbfd9 100644 --- a/Python/hbayesdm/models/_choiceRT_ddm_single.py +++ b/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. diff --git a/Python/hbayesdm/models/_cra_exp.py b/Python/hbayesdm/models/_cra_exp.py index 1f31ccdf..98d188fd 100644 --- a/Python/hbayesdm/models/_cra_exp.py +++ b/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. diff --git a/Python/hbayesdm/models/_cra_linear.py b/Python/hbayesdm/models/_cra_linear.py index 542cf77c..cce9dcfa 100644 --- a/Python/hbayesdm/models/_cra_linear.py +++ b/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. diff --git a/Python/hbayesdm/models/_dbdm_prob_weight.py b/Python/hbayesdm/models/_dbdm_prob_weight.py index 50cede01..d3c786d7 100644 --- a/Python/hbayesdm/models/_dbdm_prob_weight.py +++ b/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. diff --git a/Python/hbayesdm/models/_dd_cs.py b/Python/hbayesdm/models/_dd_cs.py index 8fb4ae9f..d64ac5f2 100644 --- a/Python/hbayesdm/models/_dd_cs.py +++ b/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. diff --git a/Python/hbayesdm/models/_dd_cs_single.py b/Python/hbayesdm/models/_dd_cs_single.py index 206cf8f4..adb2ac16 100644 --- a/Python/hbayesdm/models/_dd_cs_single.py +++ b/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. diff --git a/Python/hbayesdm/models/_dd_exp.py b/Python/hbayesdm/models/_dd_exp.py index f1e3d47c..51504dfc 100644 --- a/Python/hbayesdm/models/_dd_exp.py +++ b/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. diff --git a/Python/hbayesdm/models/_dd_hyperbolic.py b/Python/hbayesdm/models/_dd_hyperbolic.py index 74482823..36a54358 100644 --- a/Python/hbayesdm/models/_dd_hyperbolic.py +++ b/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. diff --git a/Python/hbayesdm/models/_dd_hyperbolic_single.py b/Python/hbayesdm/models/_dd_hyperbolic_single.py index 27e19781..5e1a9db0 100644 --- a/Python/hbayesdm/models/_dd_hyperbolic_single.py +++ b/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. diff --git a/Python/hbayesdm/models/_gng_m1.py b/Python/hbayesdm/models/_gng_m1.py index a334d4e6..cea64ccd 100644 --- a/Python/hbayesdm/models/_gng_m1.py +++ b/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. diff --git a/Python/hbayesdm/models/_gng_m2.py b/Python/hbayesdm/models/_gng_m2.py index e7462fb3..d7cfc916 100644 --- a/Python/hbayesdm/models/_gng_m2.py +++ b/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. diff --git a/Python/hbayesdm/models/_gng_m3.py b/Python/hbayesdm/models/_gng_m3.py index 78dd8e93..81a70703 100644 --- a/Python/hbayesdm/models/_gng_m3.py +++ b/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. diff --git a/Python/hbayesdm/models/_gng_m4.py b/Python/hbayesdm/models/_gng_m4.py index 1eb31993..75b1581e 100644 --- a/Python/hbayesdm/models/_gng_m4.py +++ b/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. diff --git a/Python/hbayesdm/models/_igt_orl.py b/Python/hbayesdm/models/_igt_orl.py index a1875675..8ca7562d 100644 --- a/Python/hbayesdm/models/_igt_orl.py +++ b/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. diff --git a/Python/hbayesdm/models/_igt_pvl_decay.py b/Python/hbayesdm/models/_igt_pvl_decay.py index 22cf816f..6af73133 100644 --- a/Python/hbayesdm/models/_igt_pvl_decay.py +++ b/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. diff --git a/Python/hbayesdm/models/_igt_pvl_delta.py b/Python/hbayesdm/models/_igt_pvl_delta.py index bde340e0..3aceabbd 100644 --- a/Python/hbayesdm/models/_igt_pvl_delta.py +++ b/Python/hbayesdm/models/_igt_pvl_delta.py @@ -100,13 +100,9 @@ def igt_pvl_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", "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. diff --git a/Python/hbayesdm/models/_igt_vpp.py b/Python/hbayesdm/models/_igt_vpp.py index 92e63edb..5c4b255d 100644 --- a/Python/hbayesdm/models/_igt_vpp.py +++ b/Python/hbayesdm/models/_igt_vpp.py @@ -108,13 +108,9 @@ def igt_vpp( 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. diff --git a/Python/hbayesdm/models/_peer_ocu.py b/Python/hbayesdm/models/_peer_ocu.py index b988950a..fee5dff6 100644 --- a/Python/hbayesdm/models/_peer_ocu.py +++ b/Python/hbayesdm/models/_peer_ocu.py @@ -106,13 +106,9 @@ def peer_ocu( 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", "condition", "p_gamble", "safe_Hpayoff", "safe_Lpayoff", "risky_Hpayoff", "risky_Lpayoff", "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", "condition", "p_gamble", "safe_Hpayoff", "safe_Lpayoff", "risky_Hpayoff", "risky_Lpayoff", "choice". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_prl_ewa.py b/Python/hbayesdm/models/_prl_ewa.py index 3791642f..4f7096da 100644 --- a/Python/hbayesdm/models/_prl_ewa.py +++ b/Python/hbayesdm/models/_prl_ewa.py @@ -100,13 +100,9 @@ def prl_ewa( 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. diff --git a/Python/hbayesdm/models/_prl_fictitious.py b/Python/hbayesdm/models/_prl_fictitious.py index 1e1a52e1..86dd7e2c 100644 --- a/Python/hbayesdm/models/_prl_fictitious.py +++ b/Python/hbayesdm/models/_prl_fictitious.py @@ -101,13 +101,9 @@ def prl_fictitious( 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. diff --git a/Python/hbayesdm/models/_prl_fictitious_multipleB.py b/Python/hbayesdm/models/_prl_fictitious_multipleB.py index 072580ab..89001207 100644 --- a/Python/hbayesdm/models/_prl_fictitious_multipleB.py +++ b/Python/hbayesdm/models/_prl_fictitious_multipleB.py @@ -103,13 +103,9 @@ def prl_fictitious_multipleB( 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", "block", "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", "block", "choice", "outcome". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_prl_fictitious_rp.py b/Python/hbayesdm/models/_prl_fictitious_rp.py index f842ac71..105ffb16 100644 --- a/Python/hbayesdm/models/_prl_fictitious_rp.py +++ b/Python/hbayesdm/models/_prl_fictitious_rp.py @@ -104,13 +104,9 @@ def prl_fictitious_rp( 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. diff --git a/Python/hbayesdm/models/_prl_fictitious_rp_woa.py b/Python/hbayesdm/models/_prl_fictitious_rp_woa.py index b40ec495..6db44471 100644 --- a/Python/hbayesdm/models/_prl_fictitious_rp_woa.py +++ b/Python/hbayesdm/models/_prl_fictitious_rp_woa.py @@ -102,13 +102,9 @@ def prl_fictitious_rp_woa( 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. diff --git a/Python/hbayesdm/models/_prl_fictitious_woa.py b/Python/hbayesdm/models/_prl_fictitious_woa.py index 0f52d118..c408824a 100644 --- a/Python/hbayesdm/models/_prl_fictitious_woa.py +++ b/Python/hbayesdm/models/_prl_fictitious_woa.py @@ -99,13 +99,9 @@ def prl_fictitious_woa( 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. diff --git a/Python/hbayesdm/models/_prl_rp.py b/Python/hbayesdm/models/_prl_rp.py index ecbdeb67..d8725822 100644 --- a/Python/hbayesdm/models/_prl_rp.py +++ b/Python/hbayesdm/models/_prl_rp.py @@ -99,13 +99,9 @@ def prl_rp( 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. diff --git a/Python/hbayesdm/models/_prl_rp_multipleB.py b/Python/hbayesdm/models/_prl_rp_multipleB.py index 1aa80ddd..5189c019 100644 --- a/Python/hbayesdm/models/_prl_rp_multipleB.py +++ b/Python/hbayesdm/models/_prl_rp_multipleB.py @@ -101,13 +101,9 @@ def prl_rp_multipleB( 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", "block", "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", "block", "choice", "outcome". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_pst_gainloss_Q.py b/Python/hbayesdm/models/_pst_gainloss_Q.py index 2e0b4dac..9ab71910 100644 --- a/Python/hbayesdm/models/_pst_gainloss_Q.py +++ b/Python/hbayesdm/models/_pst_gainloss_Q.py @@ -98,13 +98,9 @@ def pst_gainloss_Q( 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", "type", "choice", "reward". 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", "type", "choice", "reward". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ra_noLA.py b/Python/hbayesdm/models/_ra_noLA.py index 5933bd49..b8cd03cf 100644 --- a/Python/hbayesdm/models/_ra_noLA.py +++ b/Python/hbayesdm/models/_ra_noLA.py @@ -98,13 +98,9 @@ def ra_noLA( 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", "gain", "loss", "cert", "gamble". 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", "gain", "loss", "cert", "gamble". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ra_noRA.py b/Python/hbayesdm/models/_ra_noRA.py index 39628b76..02414a6d 100644 --- a/Python/hbayesdm/models/_ra_noRA.py +++ b/Python/hbayesdm/models/_ra_noRA.py @@ -98,13 +98,9 @@ def ra_noRA( 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", "gain", "loss", "cert", "gamble". 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", "gain", "loss", "cert", "gamble". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ra_prospect.py b/Python/hbayesdm/models/_ra_prospect.py index eec648c4..269b4bd5 100644 --- a/Python/hbayesdm/models/_ra_prospect.py +++ b/Python/hbayesdm/models/_ra_prospect.py @@ -100,13 +100,9 @@ def ra_prospect( 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", "gain", "loss", "cert", "gamble". 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", "gain", "loss", "cert", "gamble". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_rdt_happiness.py b/Python/hbayesdm/models/_rdt_happiness.py index 2ae268b5..2df26560 100644 --- a/Python/hbayesdm/models/_rdt_happiness.py +++ b/Python/hbayesdm/models/_rdt_happiness.py @@ -114,13 +114,9 @@ def rdt_happiness( 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", "gain", "loss", "cert", "type", "gamble", "outcome", "happy", "RT_happy". 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", "gain", "loss", "cert", "type", "gamble", "outcome", "happy", "RT_happy". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ts_par4.py b/Python/hbayesdm/models/_ts_par4.py index 07fb3ae2..33aaa6b7 100644 --- a/Python/hbayesdm/models/_ts_par4.py +++ b/Python/hbayesdm/models/_ts_par4.py @@ -101,13 +101,9 @@ def ts_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", "level1_choice", "level2_choice", "reward". 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", "level1_choice", "level2_choice", "reward". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ts_par6.py b/Python/hbayesdm/models/_ts_par6.py index d2476e2b..036c0e37 100644 --- a/Python/hbayesdm/models/_ts_par6.py +++ b/Python/hbayesdm/models/_ts_par6.py @@ -105,13 +105,9 @@ def ts_par6( 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", "level1_choice", "level2_choice", "reward". 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", "level1_choice", "level2_choice", "reward". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ts_par7.py b/Python/hbayesdm/models/_ts_par7.py index ed64b5a8..64494490 100644 --- a/Python/hbayesdm/models/_ts_par7.py +++ b/Python/hbayesdm/models/_ts_par7.py @@ -107,13 +107,9 @@ def ts_par7( 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", "level1_choice", "level2_choice", "reward". 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", "level1_choice", "level2_choice", "reward". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ug_bayes.py b/Python/hbayesdm/models/_ug_bayes.py index df627276..23cae0ed 100644 --- a/Python/hbayesdm/models/_ug_bayes.py +++ b/Python/hbayesdm/models/_ug_bayes.py @@ -96,13 +96,9 @@ def ug_bayes( 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", "offer", "accept". 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", "offer", "accept". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_ug_delta.py b/Python/hbayesdm/models/_ug_delta.py index d640319a..92899a81 100644 --- a/Python/hbayesdm/models/_ug_delta.py +++ b/Python/hbayesdm/models/_ug_delta.py @@ -96,13 +96,9 @@ def ug_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", "offer", "accept". 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", "offer", "accept". niter Number of iterations, including warm-up. Defaults to 4000. diff --git a/Python/hbayesdm/models/_wcs_sql.py b/Python/hbayesdm/models/_wcs_sql.py index d241f4a3..b1079b25 100644 --- a/Python/hbayesdm/models/_wcs_sql.py +++ b/Python/hbayesdm/models/_wcs_sql.py @@ -96,13 +96,9 @@ def wcs_sql( 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. diff --git a/commons/templates/PY_DOCS_TEMPLATE.txt b/commons/templates/PY_DOCS_TEMPLATE.txt index 28c00358..d56cf622 100644 --- a/commons/templates/PY_DOCS_TEMPLATE.txt +++ b/commons/templates/PY_DOCS_TEMPLATE.txt @@ -32,13 +32,9 @@ 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: {data_columns}. 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: {data_columns}. niter Number of iterations, including warm-up. Defaults to 4000.