write_ds_dmt: Write dataset documentation

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

write_ds_dmt() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write dataset documentation. The function is called for its side effects and does not return a value. WARNING: This function writes R scripts to your local environment. Make sure to only use if you want this behaviour

Usage

write_ds_dmt(
  db,
  db_1L_chr,
  title_1L_chr,
  desc_1L_chr,
  format_1L_chr = "A tibble",
  url_1L_chr = NA_character_,
  vars_ls = NULL,
  R_dir_1L_chr = "R",
  abbreviations_lup = NULL,
  object_type_lup = NULL
)

Arguments

db	PARAM_DESCRIPTION
db_1L_chr	Database (a character vector of length one)
title_1L_chr	Title (a character vector of length one)
desc_1L_chr	Description (a character vector of length one)
format_1L_chr	Format (a character vector of length one), Default: 'A tibble'
url_1L_chr	Url (a character vector of length one), Default: 'NA'
vars_ls	Vars (a list), Default: NULL
R_dir_1L_chr	R directory (a character vector of length one), Default: 'R'
abbreviations_lup	Abbreviations (a lookup table), Default: NULL
object_type_lup	Object type (a lookup table), Default: NULL

readyforwhatsnext/ready4fun documentation built on Nov. 22, 2020, 9:28 p.m.