Description Usage Arguments Details Value References See Also Examples

Hierarchical Bayesian Modeling of the Delay Discounting Task with the following parameters: "r" (exponential discounting rate), "beta" (inverse temperature).

**MODEL:** Exponential Model (Samuelson, 1937, The Review of Economic Studies)

1 2 3 4 |

`data` |
A .txt file containing the data to be modeled. Data columns should be labeled as:
"subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice". See |

`niter` |
Number of iterations, including warm-up. Defaults to 4000. |

`nwarmup` |
Number of iterations used for warm-up only. Defaults to 1000. |

`nchain` |
Number of Markov chains to run. Defaults to 4. |

`ncore` |
Number of CPUs to be used for running. Defaults to 1. |

`nthin` |
Every |

`inits` |
Character value specifying how the initial values should be generated. Options are "fixed" or "random", or your own initial values. |

`indPars` |
Character value specifying how to summarize individual parameters. Current options are: "mean", "median", or "mode". |

`modelRegressor` |
Export model-based regressors? TRUE or FALSE. Currently not available for this model. |

`vb` |
Use variational inference to approximately draw from a posterior distribution. Defaults to FALSE. |

`inc_postpred` |
Include trial-level posterior predictive simulations in model output (may greatly increase file size). Defaults to FALSE. |

`adapt_delta` |
Floating point value representing the target acceptance probability of a new
sample in the MCMC chain. Must be between 0 and 1. See |

`stepsize` |
Integer value specifying the size of each leapfrog step that the MCMC sampler can
take on each new iteration. See |

`max_treedepth` |
Integer value specifying how many leapfrog steps the MCMC sampler can take
on each new iteration. See |

`...` |
Not used for this model. |

This section describes some of the function arguments in greater detail.

**data** should be assigned a character value specifying the full path and name (including
extension information, e.g. ".txt") of the file that contains the behavioral data-set of all
subjects of interest for the current analysis. The file should be a **tab-delimited** text
file, whose rows represent trial-by-trial observations and columns represent variables.

For the Delay Discounting Task, there should be 6 columns of data with the
labels "subjID", "delay_later", "amount_later", "delay_sooner", "amount_sooner", "choice". It is not necessary for the columns to be in this particular order,
however it is necessary that they be labeled correctly and contain the information below:

- "subjID"
A unique identifier for each subject in the data-set.

- "delay_later"
An integer representing the delayed days for the later option (e.g. 1, 6, 28).

- "amount_later"
A floating point number representing the amount for the later option (e.g. 10.5, 13.4, 30.9).

- "delay_sooner"
An integer representing the delayed days for the sooner option (e.g. 0).

- "amount_sooner"
A floating point number representing the amount for the sooner option (e.g. 10).

- "choice"
If amount_later was selected, choice == 1; else if amount_sooner was selected, choice == 0.

*****Note: The file may contain other columns of data (e.g. "ReactionTime", "trial_number",
etc.), but only the data within the column names listed above will be used during the modeling.
As long as the necessary columns mentioned above are present and labeled correctly, there is no
need to remove other miscellaneous data columns.

**nwarmup** is a numerical value that specifies how many MCMC samples should not be stored
upon the beginning of each chain. For those familiar with Bayesian methods, this is equivalent
to burn-in samples. Due to the nature of the MCMC algorithm, initial values (i.e. where the
sampling chains begin) can have a heavy influence on the generated posterior distributions. The
`nwarmup`

argument can be set to a high number in order to curb the effects that initial
values have on the resulting posteriors.

**nchain** is a numerical value that specifies how many chains (i.e. independent sampling
sequences) should be used to draw samples from the posterior distribution. Since the posteriors
are generated from a sampling process, it is good practice to run multiple chains to ensure
that a reasonably representative posterior is attained. When the sampling is complete, it is
possible to check the multiple chains for convergence by running the following line of code:
`plot(output, type = "trace")`

. The trace-plot should resemble a "furry caterpillar".

**nthin** is a numerical value that specifies the "skipping" behavior of the MCMC sampler,
using only every `i == nthin`

samples to generate posterior distributions. By default,
`nthin`

is equal to 1, meaning that every sample is used to generate the posterior.

**Control Parameters:** `adapt_delta`

, `stepsize`

, and `max_treedepth`

are
advanced options that give the user more control over Stan's MCMC sampler. It is recommended
that only advanced users change the default values, as alterations can profoundly change the
sampler's behavior. Refer to 'The No-U-Turn Sampler: Adaptively Setting Path Lengths in
Hamiltonian Monte Carlo (Hoffman & Gelman, 2014, Journal of Machine Learning Research)' for
more information on the sampler control parameters. One can also refer to 'Section 34.2. HMC
Algorithm Parameters' of the Stan User's Guide
and Reference Manual, or to the help page for `stan`

for a less technical
description of these arguments.

A class "hBayesDM" object `modelData`

with the following components:

`model`

Character value that is the name of the model ("dd_exp").

`allIndPars`

Data.frame containing the summarized parameter values (as specified by

`indPars`

) for each subject.`parVals`

List object containing the posterior samples over different parameters.

`fit`

A class

`stanfit`

object that contains the fitted Stan model.`rawdata`

Data.frame containing the raw data used to fit the model, as specified by the user.

Samuelson, P. A. (1937). A Note on Measurement of Utility. The Review of Economic Studies, 4(2), 155. http://doi.org/10.2307/2967612

We refer users to our in-depth tutorial for an example of using hBayesDM: https://rpubs.com/CCSL/hBayesDM

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | ```
## Not run:
# Run the model and store results in "output"
output <- dd_exp("example", niter = 2000, nwarmup = 1000, nchain = 4, ncore = 4)
# Visually check convergence of the sampling chains (should look like 'hairy caterpillars')
plot(output, type = "trace")
# Check Rhat values (all Rhat values should be less than or equal to 1.1)
rhat(output)
# Plot the posterior distributions of the hyper-parameters (distributions should be unimodal)
plot(output)
# Show the WAIC and LOOIC model fit estimates
printFit(output)
## End(Not run)
``` |

hBayesDM documentation built on Dec. 14, 2018, 1:04 a.m.

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.