dm_nycflights13 {dm}R Documentation

Creates a dm object for the nycflights13 data

Description

Creates an example dm object from the tables in nycflights13, along with the references. See nycflights13::flights for a description of the data. As described in nycflights13::planes, the relationship between the flights table and the planes tables is "weak", it does not satisfy data integrity constraints.

Usage

dm_nycflights13(
  ...,
  cycle = FALSE,
  color = TRUE,
  subset = TRUE,
  compound = TRUE,
  table_description = FALSE
)

Arguments

...

These dots are for future extensions and must be empty.

cycle

Boolean. If FALSE (default), only one foreign key relation (from flights$origin to airports$faa) between the flights table and the airports table is established. If TRUE, a dm object with a double reference between those tables will be produced.

color

Boolean, if TRUE (default), the resulting dm object will have colors assigned to different tables for visualization with dm_draw().

subset

Boolean, if TRUE (default), the flights table is reduced to flights with column day equal to 10.

compound

Boolean, if FALSE, no link will be established between tables flights and weather, because this requires compound keys.

table_description

Boolean, if TRUE, a description will be added for each table that will be displayed when drawing the table with dm_draw().

Value

A dm object consisting of nycflights13 tables, complete with primary and foreign keys and optionally colored.

See Also

vignette("howto-dm-df")

Examples


dm_nycflights13() %>%
  dm_draw()


[Package dm version 1.0.10 Index]