Skip to contents

Print to the screen an easy-to-read summary of a the attributes of a dataset.

Usage

describe(x)

# S3 method for dataset
describe(x)

Arguments

x

A dataset object created with dataset::dataset.

Value

No object is returned, but they key attributes are printed on the screen.

Details

A convenience function to review the most important attributes of a dataset object. The dataset class adds a wide range of metadata as attributes to data.frame, tibble, data.table or similar R object that contains tabular data. Overviewing these attributes becomes cumbersome with base R attributes().

Examples

describe(iris_dataset)
#> Iris Dataset 
#> Dataset with 150 observations (rows) and 5 variables (columns).
#> Description: The famous (Fisher's or Anderson's) iris data set.
#> Creator: Edgar Anderson [aut]
#> Publisher: American Iris Society