adt_get_dict: Get dictionary dataset

In olssol/ADTool: Alzheimer Disease Data Tools

Description

Get the dictionary dataset as a dataframe or save as a csv file.

Usage

adt_get_dict(
  dict = c("src_files", "src_tables", "ana_data", "src_adni"),
  csv_fname = NULL
)

Arguments

dict	A string indicating the name of the dictionary. The available options are: "src_files": the dictionary for table structure, "src_tables": the dictionary for mapping column names, "ana_data": the dictionary for query, "adni": the dictionary for ADNI data.
csv_fname	A string indicating the CSV filename to be saved (saved to the default location). Default is NULL. The saved file is in .scv format. If changes of default dictionaries needed, then the costomized dictionary could be added here. However, the format of the costomized dictionary should follow the default one.

Value

The dictionary dataset.

Examples

## Not run: 
dict_par <- adt_get_dict(dict = "tbl")
dict_par <- adt_get_dict(dict = "tbl", csv_fname = "foo_tbl.csv")
## End(Not run)

olssol/ADTool documentation built on Feb. 12, 2021, 3:49 a.m.