pplr_report_dictionary: A user-friendly dictionary of the popler metadata

Description Usage Arguments Value Examples

View source: R/report_dictionary.R

Description

Provides information on the columns of metadata contained in the popler database, and the kind of data contained in those columns.

Usage

1
2
pplr_report_dictionary(full_tbl = FALSE, md_file = NULL,
  html_file = NULL)

Arguments

full_tbl

Should the function return the standard columns, or the full main table?

md_file

Specify the filename and location for the generated markdown file (optional)

html_file

Specify the filename and location for the generated html file (optional)

Value

This function is called for its side effects and does not return an R object.

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Full dictionary
pplr_report_dictionary(full_tbl = TRUE)

# "Abridged" version
pplr_report_dictionary()

## End(Not run)

AldoCompagnoni/popler documentation built on Oct. 1, 2018, 3:12 p.m.