Skip to contents

Summary and corresponding printing methods for coefs_dm objects. These objects result from a call to coef.fits_ids_dm() (i.e., when calling coef() with an object of type fits_ids_dm).

Usage

# S3 method for class 'coefs_dm'
summary(object, ..., round_digits = drift_dm_default_rounding())

# S3 method for class 'summary.coefs_dm'
print(x, ..., show_header = TRUE)

Arguments

object

an object of type coefs_dm.

...

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 class summary.coefs_dm.

show_header

logical. If TRUE, a header specifying the type of statistic will be displayed.

Value

For summary.coefs_dm() a summary object of class summary.coefs_dm.

For print.summary.coefs_dm(), the supplied object is returned invisibly.

Details

summary.coefs_dm() summarizes coefs_dm objects, returning the type, a summary of the underlying data.frame (summary_dataframe), and the number of unique IDs (n_ids).

Examples

# get a fits_ids object for demonstration purpose
fits_ids <- get_example_fits_ids()
coefs <- coef(fits_ids)
summary(coefs)
#> Object Type: coefs_dm
#> 
#> Parameters:
#>       muc             b           non_dec       sd_non_dec          tau        
#>  Min.   :4.70   Min.   :0.40   Min.   :0.30   Min.   :0.0100   Min.   :0.0400  
#>  1st Qu.:5.05   1st Qu.:0.42   1st Qu.:0.31   1st Qu.:0.0200   1st Qu.:0.0450  
#>  Median :5.40   Median :0.44   Median :0.32   Median :0.0300   Median :0.0500  
#>  Mean   :5.30   Mean   :0.48   Mean   :0.32   Mean   :0.0267   Mean   :0.0667  
#>  3rd Qu.:5.60   3rd Qu.:0.52   3rd Qu.:0.33   3rd Qu.:0.0350   3rd Qu.:0.0800  
#>  Max.   :5.80   Max.   :0.60   Max.   :0.34   Max.   :0.0400   Max.   :0.1100  
#>        A             alpha     
#>  Min.   :0.090   Min.   :3.00  
#>  1st Qu.:0.095   1st Qu.:3.35  
#>  Median :0.100   Median :3.70  
#>  Mean   :0.127   Mean   :4.57  
#>  3rd Qu.:0.145   3rd Qu.:5.35  
#>  Max.   :0.190   Max.   :7.00  
#> 
#> N IDs: 3