summary.stats_dm: Summary for `stats_dm` Objects

Description

Summary and corresponding printing methods for objects of the classes stats_dm, basic_stats, cafs, quantiles, delta_funs, fit_stats, sum_dist, and stats_dm_list. These object types result from a call to calc_stats().

Usage

# S3 method for stats_dm
summary(object, ..., round_digits = drift_dm_default_rounding())
# S3 method for basic_stats
summary(object, ...)
# S3 method for cafs
summary(object, ...)
# S3 method for quantiles
summary(object, ...)
# S3 method for delta_funs
summary(object, ...)
# S3 method for fit_stats
summary(object, ...)
# S3 method for sum_dist
summary(object, ...)
# S3 method for stats_dm_list
summary(object, ...)
# S3 method for summary.stats_dm
print(x, ..., show_header = TRUE, drop_cols = NULL)
# S3 method for summary.basic_stats
print(x, ...)
# S3 method for summary.cafs
print(x, ...)
# S3 method for summary.quantiles
print(x, ...)
# S3 method for summary.delta_funs
print(x, ...)
# S3 method for summary.fit_stats
print(x, ...)
# S3 method for summary.sum_dist
print(x, ...)
# S3 method for summary.stats_dm_list
print(x, ...)

Value

For summary.*() methods, a summary object of class corresponding to the input class.

For print.*() methods, the respective object is returned invisibly

Arguments

object: an object of the respective class
...: additional arguments passed forward.
round_digits: integer, specifying the number of decimal places for rounding the summary of the underlying data.frame. Default is 3.
x: an object of the respective class.
show_header: logical. If TRUE, a header specifying the type of statistic will be displayed.
drop_cols: character vector, specifying which columns of the table summarizing the underlying data.frame should not be displayed.

Details

summary.stats_dm(): Summarizes stats_dm objects, returning the type, a summary of the underlying data.frame (summary_dataframe), and, if possible, the number of unique IDs (n_ids).
summary.sum_dist(): Extends summary.stats_dm() with additional information about the source (source).
summary.basic_stats(): Extends summary.sum_dist() with additional information about the conditions (conds).
summary.cafs(): Extends summary.sum_dist() with additional information about the bins (bins) and conditions (conds).
summary.quantiles(): Extends summary.sum_dist() with additional information about the quantile levels (probs) and conditions (conds).
summary.delta_funs(): Extends summary.sum_dist() with additional information about the quantile levels (probs).
summary.fit_stats(): Identical to summary.stats_dm.
summary.stats_dm_list(): Applies the summary function to each element of the list and returns a list of the respective summary objects.

Note the following class relationships and properties:

basic_stats, cafs, quantiles, and delta_funs are all inheriting from sum_dist.
All sum_dist and fit_stats objects are inheriting from stats_dm.
Each stats_dm_list object is just a list containing instances of stats_dm.

Examples

Run this code

# get a model with data for demonstration purpose
a_model <- dmc_dm()
obs_data(a_model) <- dmc_synth_data

# now get some statistics and call the summary functions
some_stats <- calc_stats(a_model, type = c("quantiles", "fit_stats"))
summary(some_stats) # summary.stats_dm_list
summary(some_stats$quantiles) # summary.quantiles

Run the code above in your browser using DataLab