R: Descriptives

descriptives {jmv} | R Documentation

## Descriptives

### Description

Provides a range of descriptive statistics

### Usage

    descriptives(data, vars, splitBy = NULL, freq = FALSE, hist = FALSE,
      dens = FALSE, bar = FALSE, barCounts = FALSE, box = FALSE,
      violin = FALSE, dot = FALSE, dotType = "jitter", n = TRUE,
      missing = TRUE, mean = TRUE, median = TRUE, mode = FALSE,
      sum = FALSE, sd = FALSE, variance = FALSE, range = FALSE,
      min = TRUE, max = TRUE, se = FALSE, skew = FALSE, kurt = FALSE,
      quart = FALSE, pcEqGr = FALSE, pcNEqGr = 4)

### Arguments

`data` | the data as a data frame
`vars` | a vector of strings naming the variables of interest in `data`
`splitBy` | a vector of strings naming the variables used to split `vars`
`freq` | `TRUE` or `FALSE` (default), provide frequency tables (nominal, ordinal variables only)
`hist` | `TRUE` or `FALSE` (default), provide histograms (continuous variables only)
`dens` | `TRUE` or `FALSE` (default), provide density plots (continuous variables only)
`bar` | `TRUE` or `FALSE` (default), provide bar plots (nominal, ordinal variables only)
`barCounts` | `TRUE` or `FALSE` (default), add counts to the bar plots
`box` | `TRUE` or `FALSE` (default), provide box plots (continuous variables only)
`violin` | `TRUE` or `FALSE` (default), provide violin plots (continuous variables only)
`dot` | `TRUE` or `FALSE` (default), provide dot plots (continuous variables only)
`dotType` | .
`n` | `TRUE` (default) or `FALSE`, provide the sample size
`missing` | `TRUE` (default) or `FALSE`, provide the number of missing values
`mean` | `TRUE` (default) or `FALSE`, provide the mean
`median` | `TRUE` (default) or `FALSE`, provide the median
`mode` | `TRUE` or `FALSE` (default), provide the mode
`sum` | `TRUE` or `FALSE` (default), provide the sum
`sd` | `TRUE` or `FALSE` (default), provide the standard deviation
`variance` | `TRUE` or `FALSE` (default), provide the variance
`range` | `TRUE` or `FALSE` (default), provide the range
`min` | `TRUE` or `FALSE` (default), provide the minimum
`max` | `TRUE` or `FALSE` (default), provide the maximum
`se` | `TRUE` or `FALSE` (default), provide the standard error
`skew` | `TRUE` or `FALSE` (default), provide the skewness
`kurt` | `TRUE` or `FALSE` (default), provide the kurtosis
`quart` | `TRUE` or `FALSE` (default), provide quartiles
`pcEqGr` | `TRUE` or `FALSE` (default), provide quantiles
`pcNEqGr` | an integer (default: 4) specifying the number of equal groups

### Value

A results object containing:

`results$descriptives` |  |  |  |  | a table of the descriptive statistics
`results$frequencies` |  |  |  |  | an array of frequency 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)`

### Examples

    ## Not run:
    data('mtcars')
    dat <- mtcars

    # frequency tables can be provided for factors
    dat$gear <- as.factor(dat$gear)

    descriptives(dat, vars = c('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
    #  --------------------
    #

    ## End(Not run)

[Package jmv version 0.8.6.2 Index]