wrds (version 0.0.1)

describe_table: Describe a table

Description

Displays a glimpse-like summary of a WRDS table showing column names and types, similar to dplyr::glimpse().

Usage

describe_table(wrds, library, table, n = 20, max_cols = 25)

Value

Invisibly returns a list with components:

columns

A data frame with column_name and data_type

nrow

Row count

sample

A data frame with sample rows (if n > 0)

Arguments

wrds

A DBIConnection object returned by wrds_connect().

library

Character. The name of the library (schema).

table

Character. The name of the table.

n

Integer. Number of sample rows to fetch for value preview. Default is 20.

max_cols

Integer. Maximum number of columns to display. Default is 25.

Examples

if (FALSE) {
wrds <- wrds_connect()
describe_table(wrds, "comp", "funda")
wrds_disconnect(wrds)
}