update_dyad: Update dyad

In ready4-dev/ready4use: Ingest, Label, Visualise and Share Health Economic Model Datasets

Update dyad

Description

update_dyad() is an Update function that edits an object, while preserving core object attributes. Specifically, this function implements an algorithm to update dyad. The function is called for its side effects and does not return a value.

Usage

update_dyad(
  X_Ready4useDyad,
  arrange_1L_chr = c("var_ctg_chr, var_nm_chr", "category", "name", "both",
    "var_ctg_chr", "var_nm_chr"),
  categories_chr = character(0),
  dictionary_lups_ls = list(),
  dictionary_r3 = ready4use_dictionary(),
  exclude_chr = character(0),
  fn = NULL,
  fn_args_ls = NULL,
  lup_prototype_tb = NULL,
  match_var_nm_1L_chr = character(0),
  method_1L_chr = c("first", "sample"),
  names_chr = character(0),
  type_1L_chr = c("keep", "drop", "mutate", "update", "sequential", "batch", "self"),
  vars_chr = character(0),
  what_1L_chr = c("all", "dataset", "dictionary")
)

Arguments

X_Ready4useDyad	PARAM_DESCRIPTION
arrange_1L_chr	Arrange (a character vector of length one), Default: c("var_ctg_chr, var_nm_chr", "category", "name", "both", "var_ctg_chr", "var_nm_chr")
categories_chr	Categories (a character vector), Default: character(0)
dictionary_lups_ls	Dictionary lookup tables (a list), Default: list()
dictionary_r3	Dictionary (a ready4 submodule), Default: ready4use_dictionary()
exclude_chr	Exclude (a character vector), Default: character(0)
fn	Function (a function), Default: NULL
fn_args_ls	Function arguments (a list), Default: NULL
lup_prototype_tb	Lookup table prototype (a tibble), Default: NULL
match_var_nm_1L_chr	Match variable name (a character vector of length one), Default: character(0)
method_1L_chr	Method (a character vector of length one), Default: c("first", "sample")
names_chr	Names (a character vector), Default: character(0)
type_1L_chr	Type (a character vector of length one), Default: c("keep", "drop", "mutate", "update", "sequential", "batch", "self")
vars_chr	Variables (a character vector), Default: character(0)
what_1L_chr	What (a character vector of length one), Default: c("all", "dataset", "dictionary")

Value

X (A dataset and data dictionary pair.)

ready4-dev/ready4use documentation built on June 1, 2025, 2:06 p.m.