summary.drift_dm: Summary for 'drift_dm' Objects

In dRiftDM: Estimating (Time-Dependent) Drift Diffusion Models

Summary for drift_dm Objects

Description

Summary and corresponding printing methods for objects of the class drift_dm, resulting from a call to drift_dm().

Usage

## S3 method for class 'drift_dm'
summary(object, ...)

## S3 method for class 'summary.drift_dm'
print(x, ..., round_digits = drift_dm_default_rounding())

Arguments

object	an object of class drift_dm
...	additional arguments passed forward.
x	an object of type summary.drift_dm
round_digits	integer, specifying the number of decimal places for rounding in the printed summary. Default is 3.

Details

The summary.drift_dm() function constructs a summary list with detailed information about the drift_dm object, including:

• class: The class type of the drift_dm object.

• summary_flex_prms: A summary of the flex_prms object in the model (see summary.flex_prms).

• prms_solve: Parameters used for solving the model (see prms_solve).

• solver: The solver used for model fitting.

• b_coding: The boundary coding for the model (see b_coding).

• obs_data: A summary table of observed response time data, if available, by response type (upper/lower boundary responses). Includes sample size, mean, and quantiles.

• fit_stats: Fit statistics, if available, including log-likelihood, AIC, and BIC values.

The print.summary.drift_dm() function displays this summary in a formatted way.

Value

summary.drift_dm() returns a list of class summary.drift_dm (see the Details section summarizing each entry of this list).

print.summary.drift_dm() returns invisibly the summary.drift_dm object.

Examples

# get a pre-built model for demonstration purpose
a_model <- dmc_dm(t_max = 1.5, dx = .0025, dt = .0025)
sum_obj <- summary(a_model)
print(sum_obj, round_digits = 2)

# more information is provided when we add data to the model
obs_data(a_model) <- dmc_synth_data # (data set comes with dRiftDM)
summary(a_model)

# finally: fit indices are provided once we evaluate the model
a_model <- re_evaluate_model(a_model)
summary(a_model)

dRiftDM documentation built on April 3, 2025, 7:48 p.m.