ff_interaction: Make an interaction variable and add to dataframe

View source: R/ff_interaction.R

ff_interactionR Documentation

Make an interaction variable and add to dataframe

Description

Combine two factor variables to make an interaction variable. Factor level order is determined by the order in the variables themselves. Note, names of the factor variables should not be quoted. The name of the variable is created from the names of the two factors. The variable is also labelled with a name derived from any pre-existing labels.

Usage

ff_interaction(.data, ..., levels_sep = "_", var_sep = "_", label_sep = ":")

finalfit_interaction(
  .data,
  ...,
  levels_sep = "_",
  var_sep = "_",
  label_sep = ":"
)

Arguments

.data

Data frame.

...

The unquoted names of two factors.

levels_sep

Quoted character: how levels are separated in new variable.

var_sep

Quoted character: how variable name is separated.

label_sep

Quoted character: how variable label is separated

Value

Original data frame with new variable added via 'dplyr::mutate'.

Examples


colon_s %>%
  ff_interaction(sex.factor, perfor.factor) %>%
    summary_factorlist("mort_5yr", "sex.factor_perfor.factor")

finalfit documentation built on Sept. 11, 2024, 9:01 p.m.