summary.coefs_dm {dRiftDM} | R Documentation |
Summary for coefs_dm
Objects
Description
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 |
... |
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 |
show_header |
logical. If |
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
).
Value
For summary.coefs_dm()
a summary object of class summary.coefs_dm
.
For print.summary.coefs_dm()
, the supplied object is returned
invisibly.
Examples
# get a fits_ids object for demonstration purpose
fits_ids <- get_example_fits_ids()
coefs <- coef(fits_ids)
summary(coefs)