datamodelr (version 0.2.1.9001)

dm_read_yaml: Read YAML

Description

Reads a file in YAML format and returns a data model object.

Usage

dm_read_yaml(file = NULL, text = NULL)

Arguments

file

A file in YAML format

text

A YAML formated character string

Details

YAML description should include table names (first level), columns (second level) and column attributes (third level). Expected (but not required) column attributes are key (Yes|No), ref (Name of referenced table), comment (column description).

Examples

# NOT RUN {
dm <-
  dm_read_yaml(text = "

    Person:
      Person ID: {key: yes}
      Name:
      E-mail:
      Street:
      Street number:
      City:
      ZIP:

    Order:
      Order ID: {key: yes}
      Customer: {ref: Person}
      Sales person: {ref: Person}
      Order date:
      Requested ship date:
      Status:

    Order Line:
      Order ID: {key: yes, ref: Order}
      Line number: {key: yes}
      Order item: {ref: Item}
      Quantity:
      Price:

    Item:
      Item ID: {key: yes}
      Item Name:
      Description:
  ")
# }