junco (version 0.1.2)

create_colspan_map: Creation of Column Spanning Mapping Dataframe

Description

A function used for creating a data frame containing the map that is compatible with rtables split function. trim_levels_to_map

Usage

create_colspan_map(
  df,
  non_active_grp = c("Placebo"),
  non_active_grp_span_lbl = " ",
  active_grp_span_lbl = "Active Study Agent",
  colspan_var = "colspan_trt",
  trt_var = "TRT01A",
  active_first = TRUE
)

Value

A data frame that contains the map to be used with rtables split function trim_levels_to_map.

Arguments

df

(data.frame)
The name of the data frame in which the spanning variable is to be appended to

non_active_grp

(character)
The value(s) of the treatments that represent the non-active or comparator treatment groups default value = c('Placebo')

non_active_grp_span_lbl

(character)
The assigned value of the spanning variable for the non-active or comparator treatment groups default value = ''

active_grp_span_lbl

(character)
The assigned value of the spanning variable for the active treatment group(s) default value = 'Active Study Agent'

colspan_var

(character)
The desired name of the newly created spanning variable default value = 'colspan_trt'

trt_var

(character)
The name of the treatment variable that is used to determine which spanning treatment group value to apply. default value = 'TRT01A'

active_first

(logical)
whether the active columns come first.

Details

This function creates a data frame containing the map that is compatible with rtables split function trim_levels_to_map. The levels of the specified trt_var variable will be stored within the trt_var variable and the colspan_var variable will contain the corresponding spanning header value for each treatment group.

Examples

library(tibble)

df <- tribble(
  ~TRT01A,
  "Placebo",
  "Active 1",
  "Active 2"
)

df$TRT01A <- factor(df$TRT01A, levels = c("Placebo", "Active 1", "Active 2"))

colspan_map <- create_colspan_map(
  df = df,
  non_active_grp = c("Placebo"),
  non_active_grp_span_lbl = " ",
  active_grp_span_lbl = "Active Study Agent",
  colspan_var = "colspan_trt",
  trt_var = "TRT01A"
)

colspan_map