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("fits_ids_dm")
coefs <- coef(fits_ids)
summary(coefs)
#> Object Type: coefs_dm
#>
#> Parameters:
#> muc b non_dec sd_non_dec
#> Min. :4.70 Min. :0.391 Min. :0.297 Min. :0.0120
#> 1st Qu.:4.70 1st Qu.:0.418 1st Qu.:0.307 1st Qu.:0.0221
#> Median :4.70 Median :0.446 Median :0.318 Median :0.0323
#> Mean :5.12 Mean :0.488 Mean :0.319 Mean :0.0285
#> 3rd Qu.:5.33 3rd Qu.:0.536 3rd Qu.:0.330 3rd Qu.:0.0368
#> Max. :5.96 Max. :0.626 Max. :0.341 Max. :0.0413
#> tau A alpha
#> Min. :0.0322 Min. :0.0893 Min. :3.33
#> 1st Qu.:0.0667 1st Qu.:0.0956 1st Qu.:4.19
#> Median :0.1012 Median :0.1019 Median :5.04
#> Mean :0.0812 Mean :0.1286 Mean :4.99
#> 3rd Qu.:0.1056 3rd Qu.:0.1483 3rd Qu.:5.82
#> Max. :0.1101 Max. :0.1947 Max. :6.61
#>
#> N IDs: 3