summary.traces_dm {dRiftDM}R Documentation

Summary for traces_dm and traces_dm_list Objects

Description

Summary and corresponding printing methods for traces_dm and traces_dm_list objects, resulting from a call to simulate_traces(). Here, traces_dm objects are entries of the returned list.

Usage

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

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

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

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

Arguments

object

an object of class traces_dm or traces_dm_list.

...

additional arguments passed forward.

x

an object of type summary.traces_dm or summary.traces_dm_list.

round_digits

integer, specifying the number of decimal places for rounding in the printed summary. Default is 3.

Details

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

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

The print.summary.traces_dm() and print.summary.traces_dm_list() functions display the summary in a formatted way.

Value

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

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

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

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

Examples

# get a couple of traces a cross conditions
traces <- simulate_traces(dmc_dm(), k = c(5, 10))
summary(traces)

# get a single traces object
one_traces_obj <- traces[[1]]
summary(one_traces_obj)


[Package dRiftDM version 0.2.2 Index]