userfriendlyscience (version 0.7.2)

examine: Examine one or more variables

Description

These functions are one of many R functions enabling users to assess variable descriptives. They have been developed to mimic SPSS' 'EXAMINE' syntax command ('Explore' in the menu) as closely as possible to ease the transition for new R users and facilitate teaching courses where both programs are taught alongside each other.

Usage

examine(..., stem = TRUE, plots = TRUE,
        extremeValues = 5, descr.include = NULL,
        qqCI = TRUE, conf.level = 0.95)
examineBy(..., by=NULL, stem = TRUE, plots = TRUE,
          extremeValues = 5, descr.include=NULL,
          qqCI = TRUE, conf.level=.95)

Arguments

The first argument is a list of variables to provide descriptives for. Because these are the first arguments, the other arguments must be named explicitly so R does not confuse them for something that should be part of the dots.

by

A variable by which to split the dataset before calling examine. This can be used to show the descriptives separate by levels of a factor.

stem

Whether to display a stem and leaf plot.

plots

Whether to display the plots generated by the dataShape function.

extremeValues

How many extreme values to show at either end (the highest and lowest values). When set to FALSE (or 0), no extreme values are shown.

qqCI

Whether to display confidence intervals in the QQ-plot.

descr.include

Which descriptives to include; see descr for more information.

conf.level

The level of confidence of the confidence interval.

Value

A list that is displayed when printed.

Details

This function basically just calls the descr function, optionally supplemented with calls to stem, dataShape.

See Also

descr, dataShape, stem

Examples

# NOT RUN {
### Look at the miles per gallon descriptives:
examine(mtcars$mpg, stem=FALSE, plots=FALSE);

### Separate for the different number of cylinders:
examineBy(mtcars$mpg, by=mtcars$cyl,
          stem=FALSE, plots=FALSE,
          extremeValues=FALSE,
          descr.include=c('central tendency', 'spread'));

# }