Learn R Programming

ddModel (version 0.2.9.0)

ddm-class: An S4 Class Representing a Decision Diffusion Model

Description

The ddm class represents a complete Decision Diffusion Model (DDM) specification. It encapsulates a model objects from the ggdmcModel package, and optionally a population distribution created via the BuildPrior function from the ggdmcPrior package.

Usage

setDDM(model, population_distribution = NULL)

Value

An object of S4 class ddm, which includes:

  • model: the model specification

  • population_distribution: the prior distribution (if provided)

Arguments

model

A required model object defining the model specification.

population_distribution

Optional A population-level prior distribution, typically constructed with BuildPrior. This argument enables simulations of subject-level parameters. Default is NULL.

Slots

model

A model object from ggdmcModel package that defines the DDM structure, including parameter names, mapping, and data attributes.

population_distribution

An optional prior distribution, typically created via BuildPrior from the ggdmcPrior package. This slot is primarily used for parameters or hierarchical modelling and can be NULL.

Details

The constructor function setDDM creates a ddm object by wrapping the model and optionally a population distribution into a single structure. This class is designed for compatibility with sampling and simulation functions within the ggdmc ecosystem.

See Also

model-class, BuildPrior