describe: Describe a dataset

View source: R/describe.R

describeR Documentation

Describe a dataset

Description

Describe a dataset

Usage

describe(x, con = NULL)

Arguments

x

A dataset_df object.

con

A connection, for example, con=tempfile().

Value

The description of the dataset_df object is written to the connection in the N-Triples form. If con=NULL, then the serialisation takes place in tempfile() and the contents are printed to the console; if a file is given, than no output is returned.

Examples


# See the serialisation on the screen:
describe(orange_df)

# Save it to a connection:
temporary_connection <- tempfile()
describe(orange_df, con = temporary_connection)

dataset documentation built on June 8, 2025, 10:15 a.m.