print.summary.fits_ids_dm {dRiftDM}R Documentation

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:

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)


[Package dRiftDM version 0.2.2 Index]