lessR (version 1.9.8)

describe: Summary Statistics with an Option for Each Level of Another Variable

Description

Descriptive or summary statistics for a numeric variable or a factor, one at a time or for all numeric and factor variables in the data matrix. For a single variable, there is also an option for summary statistics at each level of a second, usually categorical variable or factor, with a relatively few number of levels. Includes the sample mean, standard deviation, minimum, median and maximum for the numeric summary, and the table of counts for each value of a factor. For numeric variables, also includes the number of non-missing and missing values.

Usage

describe(x=NULL, ...)
## S3 method for class 'numeric':
describe(x, digits.d=NULL, lbl=NULL, \dots)
## S3 method for class 'factor':
describe(x, lbl=NULL, \dots)
## S3 method for class 'formula':
describe(formula, data=mydata, \dots)
## S3 method for class 'data.frame':
describe(x, \dots)
## S3 method for class 'character':
describe(x, lbl=NULL, \dots)
## S3 method for class 'default':
describe(x, \dots)

Arguments

x

Values of response variable for first group. If ignored, then the data frame mydata becomes the default value.

formula

A formula of the form Y ~ X, where Y is the numeric response variable compared across the two groups, and X is a grouping variable (factor) with two levels that define the corresponding groups.

data

An optional matrix or data frame containing the variables in the formula. By default the variables are taken from environment (formula).

lbl

A name to use to label the output of a variable in lieu of its name.

digits.d

Specifies the number of decimal digits to display in the output.

...

Further arguments to be passed to or from methods, which is the option digits which specifies the number of decimal digits to display in the output when calling with a formula.

Details

The formula version specifies a categorical variable or factor, with a relatively few number of values called levels. The formula method is invoked with an expression of the form Y ~ X, with the names Y and X replaced by the actual variable names specific to a particular analysis, where Y is a numeric variable and X is a categorical variable with relatively few values or levels. The formula method automatically retrieves the names of the variables and data values for display on the resulting output. Then the response variable is analyzed at each level of the factor.

The digits.d parameter specifies the number of decimal digits in the output. It must follow the formula specification when used with the formula version. By default the number of decimal digits displayed for the analysis of a variable is one more than the largest number of decimal digits in the data for that variable.

The function rad in this package reads the data from an external csv file into the data frame called mydata. To describe all of the variables in this data frame, invoke describe(mydata), or just describe(), which then defaults to the former.

See Also

summary, formula.

Examples

# ----------------------------------------------------------
# Data simulated, call describe with a formula
# ----------------------------------------------------------

# Create simulated data, no population mean difference
# X has two values only, Y is numeric
n <- 12
X <- sample(c("Group1","Group2"), size=n, replace=TRUE)
Y <- round(rnorm(n=n, mean=50, sd=10),3)

# Analyze all the values of numerical Y and categorical X
describe(Y)
describe(X)

# Analyze data with formula version
# Get the summary statistics for Y at each level of X
# Specify 3 decimal digits for each statistic displayed
describe(Y ~ X, digits.d=2)

# Analyze a small example data set from the web
# Read data into mydata data frame with the rad function 
# Optionally display the data frame by listing its name
# Analyze all variables in the data table with describe()
#rad("http://web.pdx.edu/~gerbing/data/employees2.csv")
#mydata
#describe()

# Use the subset function to specify a variable list
#describe(subset(mydata, select=c(Age:Dept,HealthPlan)))