describr
objectdescribr.Rd
This is the core object for describr
package.
All information required to create a descriptive table for a data frame is
stored a describr
-object.
describr(df, by = NULL, theme_new = theme_default(), pvalues = FALSE, totals = TRUE, caption = "")
df | a data frame. |
---|---|
by | unquoted name of optional stratifying factor |
theme_new | theme to use |
pvalues | Flag indicating whether p-values for homogeneity null hypothesis should be printed if available. |
total | Flag indicating whether all descriptors should also be given for the total sample. |
An object of class describr < list
with fields:
df
data frame to describe
by
variable name by which to stratify the description (character or NULL)
core
named list with names corresponding
to the variables in df
which will b described and eac element
is a list of descriptor
objects osed to describe that variable.
TODO: rename!
group_descriptors
list of descriptors used for the grouping
(stratifying) variable by
.
pvalues
Boolean flag indicating whether p-values should be displayed
totals
Boolean flag indicating whether a total column should be included when the description is stratified by a grouping factor.
theme_new
The theme to use for plotting. TODO: rename