inset_target: Insets target vector back to input object ('x')

In stasvlasov/nstandr: Name Standardization in R

Insets target vector back to input object (x)

Description

Insets target vector back to input object (x)

Usage

inset_target(
  vector,
  x,
  omitted_rows_value_for_new_col = NULL,
  allow_na_in_vector = TRUE,
  which_call_to_report = -5L,
  return_only_target_col = FALSE,
  ...
)

Arguments

vector	Character vector to inset into the x object
x	Data to standardize. Character vector or data.frame or data.table
omitted_rows_value_for_new_col	Alternative value omitted_rows_value to use in case we create new column in x. For example, it is use in insetting codes to avoid the default omitted_rows_value use initial col in which case codes will be mixed with input values
allow_na_in_vector	Whether to allow NA in inset vector
which_call_to_report	System call number (e.g., -2L) to include in report if arguments checks fails
return_only_target_col	If toggled to TRUE then only return the vector to be inset (output_placement argument is ignored)
...	Arguments passed on to standardize_options col Column of interest (the one we need to standardize) in the x object (if it is data.frame like). rows Logical vector to filter records of interest. Default is NULL which means do not filter records. omitted_rows_value If rows parameter is set then merge omitted_rows_value with the results (filtered by rows). Either single string or a character vector of length nrow(x). If NULL (the default) then original values of col are merged with results. output_placement Where to inset retults (standardized vector) in the x object. Default options is 'replace_col' which overwrides the col in x with results. Other options: 'omit' :: do not write results back to table (usually used when append_output_copy is set for temporary values) 'prepend_to_col' :: prepend to col 'append_to_col' :: append to col 'prepend_to_x' :: prepend to x data.frame like object 'append_to_x' :: append to x data.frame like object x_atomic_name If x is vector use this name for original column if it is in results. Default is "x". If x is table the name of col will be used. output_col_name Use this name for the column with results (standardized values). Parts in curly brakeds are substitute strings. Options for substitutions are: append_output_copy Whether to append a copy of result vector to x object output_copy_col_name How the append copy wiil be named

Value

Data.table or character vector

stasvlasov/nstandr documentation built on July 27, 2023, 10:29 p.m.