R: Display Compact Abstract of a Data Frame

Abstract {DescTools} | R Documentation

## Display Compact Abstract of a Data Frame

### Description

Compactly display the content and structure of a data.frame, including variable labels. `str` is optimised for lists and its output is relatively technical, when it comes to e.g. attributes. `summary` on the other side already calculates some basic statistics.

### Usage

    Abstract(x, sep = ", ", zero.form = ".", maxlevels = 5, trunc = TRUE, list.len = 99)

### Arguments

`x` | a `data.frame` to be described
`sep` | the separator for concatenating the levels of a factor
`zero.form` | a symbol to be used, when a variable has zero NAs.
`maxlevels` | integer, defining how many factor levels are to be displayed. Default is 12. Set this to Inf, if all levels are needed.
`trunc` | logical, defining if level names excceeding the column with should be truncated. Default ist `TRUE`.
`list.len` | numeric; maximum number of list elements to display.

### Details

The levels of a factor and describing variable labels (as created by `Label`) will be wrapped within the columns.

The first 4 columns are printed with the needed fix width, the last 2 (Levels and Labels) are wrapped within the column. The width is calculated depending on the width of the screen as given by `getOption("width")`.

ToWord has an interface for the class `abstract`.

### Value

an object of class `abstract`, essentially a character matrix with 5 or 6 columns containing a sequential nr (Nr), the name of the column (ColName), the class (Class), the number of NAs (NAs), the levels if the variable is a factor (Levels) and - if there are any - descriptive labels for the column (Labels). .

### Author(s)

Andri Signorell <andri@signorell.net>

### See Also

`str`, `summary`, `ColumnWrap`

### Examples

    d.mydata <- d.pizza
    # let's use some labels
    Label(d.mydata) <- "Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
    sed diam voluptua. At vero eos et accusam."

    Label(d.mydata$temperature) <- "Amet, consetetur sadipscing elitr, sed diam nonumy "

    Abstract(d.mydata)

[Package DescTools version 0.99.24 Index]