Read an Ontario-Catalogue Markdown data-dictionary sidecar.

Parses a simple pipe-table Markdown sidecar of the form

| name | type | notes |
|------|------|-------|
| foo  | int  | ...   |

as published by some ARSAU releases. No external dependencies are required: the parser is pure base R.

Usage

morie_arsau_read_markdown_dictionary(path)

Arguments

path

Path to the Markdown file.

Value

A data.frame with one row per table row. Returns an empty data.frame if the file has no parseable pipe table.

References

Ontario Ministry of the Solicitor General data dictionaries accompanying the ARSAU CSV releases.

Examples

path <- system.file("extdata", "OTIS_DATA_DICTIONARY.md",
                    package = "morie")
if (nzchar(path)) {
  out <- morie_arsau_read_markdown_dictionary(path)
  str(out)
}