describe {prettyR}R Documentation

Description of variables

Description

Describes a vector or the columns in a matrix or data frame.

Usage

 describe(x,num.desc=c("mean","median","var","sd","valid.n"),show.num.fac=FALSE,xname=NA)

Arguments

x A vector, matrix or data frame.
num.desc The names of the functions to apply to numeric data.
show.num.fac Whether to display a numeric description of all numeric factor data.
xname A name for the object x, mostly where this would be a very long string describing its structure (e.g. if it was extracted by name from a data frame).

Details

describe displays a table of descriptive statistics for numeric and factor variables in the object x. If show.num.fac is TRUE, factors with all numeric levels will be displayed twice, once with a numeric summary, once with a factor summary. The summary measures for numeric variables can easily be altered with the argument num.desc. Pass a character vector with the names of the desired summary measures and these will be displayed at the top of the numeric block with their results beneath them. If quantiles are desired, the user will have to write wrapper functions that call quantile with the appropriate type or probabilities and use the names of the wrapper functions in num.desc.

Value

nil

Author(s)

Jim Lemon

See Also

Mode, valid.n, describe.numeric, describe.factor

Examples

 sample.df<-data.frame(sex=sample(c("MALE","FEMALE"),100,TRUE),
  income=(rnorm(100)+2.5)*20000,suburb=factor(sample(1:4,100,TRUE)))
 # show the suburb factor as both factor and numeric
 describe(sample.df,show.num.fac=TRUE)

[Package prettyR version 1.0-2 Index]