summary.fits_ids_dm: Summary and Printing for fits_ids_dm Objects

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

Summary and Printing for fits_ids_dm Objects

Description

Methods for summarizing and printing objects of the class fits_ids_dm, which contain multiple fits across individuals.

Usage

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

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

Arguments

x	an object of class summary.fits_ids_dm.
...	additional arguments
round_digits	integer, specifying the number of decimal places for rounding in the printed summary. Default is set to 3.
object	an object of class fits_ids_dm, generated by a call to load_fits_ids.

Details

The summary.fits_ids_dm function creates a summary object containing:

• fit_procedure_name: The name of the fit procedure used.

• time_call: Timestamp of the last fit procedure call.

• lower and upper: Lower and upper bounds of the search space.

• model_type: Description of the model type, based on class information.

• prms: All parameter values across all conditions (essentially a call to coef() with the argument select_unique = FALSE).

• stats: A named list of matrices for each condition, including mean and standard error for each parameter.

• N: The number of individuals.

The print.summary.fits_ids_dm function displays the summary object in a formatted manner.

Value

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

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

Examples

# get an auxiliary object of type fits_ids_dm for demonstration purpose
all_fits <- get_example_fits_ids()
sum_obj <- summary(all_fits)
print(sum_obj, round_digits = 2)

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