View source: R/descriptives.h.R
descriptives | R Documentation |
Descriptives are an assortment of summarising statistics, and visualizations which allow exploring the shape and distribution of data. It is good practice to explore your data with descriptives before proceeding to more formal tests.
descriptives(data, vars, splitBy = NULL, freq = FALSE,
desc = "columns", hist = FALSE, dens = FALSE, bar = FALSE,
barCounts = FALSE, box = FALSE, violin = FALSE, dot = FALSE,
dotType = "jitter", boxMean = FALSE, boxLabelOutliers = TRUE,
qq = FALSE, n = TRUE, missing = TRUE, mean = TRUE,
median = TRUE, mode = FALSE, sum = FALSE, sd = TRUE,
variance = FALSE, range = FALSE, min = TRUE, max = TRUE,
se = FALSE, ci = FALSE, ciWidth = 95, iqr = FALSE,
skew = FALSE, kurt = FALSE, sw = FALSE, pcEqGr = FALSE,
pcNEqGr = 4, pc = FALSE, pcValues = "25,50,75", extreme = FALSE,
extremeN = 5, formula)
data |
the data as a data frame |
vars |
a vector of strings naming the variables of interest in
|
splitBy |
a vector of strings naming the variables used to split
|
freq |
|
desc |
|
hist |
|
dens |
|
bar |
|
barCounts |
|
box |
|
violin |
|
dot |
|
dotType |
. |
boxMean |
|
boxLabelOutliers |
|
qq |
|
n |
|
missing |
|
mean |
|
median |
|
mode |
|
sum |
|
sd |
|
variance |
|
range |
|
min |
|
max |
|
se |
|
ci |
|
ciWidth |
a number between 50 and 99.9 (default: 95), the width of confidence intervals |
iqr |
|
skew |
|
kurt |
|
sw |
|
pcEqGr |
|
pcNEqGr |
an integer (default: 4) specifying the number of equal groups |
pc |
|
pcValues |
a comma-sepated list (default: 25,50,75) specifying the percentiles |
extreme |
|
extremeN |
an integer (default: 5) specifying the number of extreme values |
formula |
(optional) the formula to use, see the examples |
A results object containing:
results$descriptives | a table of the descriptive statistics | ||||
results$descriptivesT | a table of the descriptive statistics | ||||
results$frequencies | an array of frequency tables | ||||
results$extremeValues | an array of extreme values tables | ||||
results$plots | an array of descriptive plots | ||||
Tables can be converted to data frames with asDF
or as.data.frame
. For example:
results$descriptives$asDF
as.data.frame(results$descriptives)
data('mtcars')
dat <- mtcars
# frequency tables can be provided for factors
dat$gear <- as.factor(dat$gear)
descriptives(dat, vars = vars(mpg, cyl, disp, gear), freq = TRUE)
#
# DESCRIPTIVES
#
# Descriptives
# -------------------------------------------
# mpg cyl disp gear
# -------------------------------------------
# N 32 32 32 32
# Missing 0 0 0 0
# Mean 20.1 6.19 231 3.69
# Median 19.2 6.00 196 4.00
# Minimum 10.4 4.00 71.1 3
# Maximum 33.9 8.00 472 5
# -------------------------------------------
#
#
# FREQUENCIES
#
# Frequencies of gear
# --------------------
# Levels Counts
# --------------------
# 3 15
# 4 12
# 5 5
# --------------------
#
# spliting by a variable
descriptives(formula = disp + mpg ~ cyl, dat,
median=F, min=F, max=F, n=F, missing=F)
# providing histograms
descriptives(formula = mpg ~ cyl, dat, hist=T,
median=F, min=F, max=F, n=F, missing=F)
# splitting by multiple variables
descriptives(formula = mpg ~ cyl:gear, dat,
median=F, min=F, max=F, missing=F)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.