camr_join_on_idx: Safely left-join two dataframes on CAM index columns.

In rettopnivek/camrprojects: Portable Functions for R Projects at CAM-MGH

Safely left-join two dataframes on CAM index columns.

Description

Usage

camr_join_on_idx(df_x, df_y)

Arguments

df_x	A dataframe, with columns following the CAM naming convention.
df_y	A dataframe, with columns following the CAM naming convention.

Details

By convention, columns beginning with the prefix IDX are index columns. This function will perform a left_join, mapping the IDX columns of df_y onto those matching in df_x. In the returned dataframe, the IDX columns will be in the leftmost position.

Value

left_join(df_x, df_y, by=camr_list_idx(df_y))

Examples

## Not run: 
df_scans |>
  camr_join_on_idx(
    df_demographics)
  )

## End(Not run)

rettopnivek/camrprojects documentation built on March 26, 2024, 9:17 a.m.