describe {arkhe}

Data Description

Description

Describes an object.

Usage

describe(x, ...)

## S4 method for signature 'ANY'
describe(x)

Arguments

x

An R object (should be a matrix or a data.frame).

...

Currently not used.

Value

describe() is called for its side-effects. Invisibly returns x.

Author(s)

N. Frerebeau

See Also

Other data summaries: sparsity()

Examples

## Create a data matrix
X <- matrix(sample(0:9, 15, TRUE), nrow = 3, ncol = 5)

## Add NA
k <- sample(1:15, 3, FALSE)
X[k] <- NA

## Sparsity
sparsity(X)

## Quick description
describe(X)