This function arranges and annotates a data frame based on specified types of treatment effect estimates (RR or RD). It supports different sorting options including default descending, alphabetical, and custom order. It now also handles original scale estimates when available.
Arguments
- df
Data frame containing the variables of interest, or a list containing the results dataframe and label mapping from transform_to_original_scale().
- type
Type of treatment effect to analyze. Expected values are 'RR' for Risk Ratio and 'RD' for Risk Difference. Defaults to 'RD'.
- order
Specifies the order in which the outcomes should be arranged. Can be 'default' for descending order of the estimate, 'alphabetical' for alphabetical order by outcome, or 'custom' for a user-defined order. Default is 'default'.
- custom_order
A vector of custom ordering for the outcomes, applicable if `order` is set to 'custom'. This should be a vector containing all outcomes in the desired order.
Value
A data frame that has been arranged based on the specified order and annotated with treatment effect estimates, estimate labels, and evidence value annotations. If original scale estimates are available, these will be included in the output.
Details
The function now handles both transformed and original scale results. If original scale results are available (indicated by the presence of columns with "_original" suffix), these will be included in the output. The function also applies label mapping if provided.
Examples
# Example using Risk Ratio (RR) and default sorting
result_df <- group_tab(df = analysis_df, type = 'RR')
#> Error in group_tab(df = analysis_df, type = "RR"): could not find function "group_tab"
# Example using Risk Difference (RD) with alphabetical sorting
result_df <- group_tab(df = analysis_df, type = 'RD', order = 'alphabetical')
#> Error in group_tab(df = analysis_df, type = "RD", order = "alphabetical"): could not find function "group_tab"
# Example using custom sorting order
custom_order <- c("Outcome3", "Outcome1", "Outcome2")
result_df <- group_tab(df = analysis_df, type = 'RR', order = 'custom', custom_order = custom_order)
#> Error in group_tab(df = analysis_df, type = "RR", order = "custom", custom_order = custom_order): could not find function "group_tab"
# Example using output from transform_to_original_scale()
transformed_data <- transform_to_original_scale(results_df, original_df, label_mapping)
#> Error in transform_to_original_scale(results_df, original_df, label_mapping): could not find function "transform_to_original_scale"
result_df <- group_tab(transformed_data, type = 'RD')
#> Error in group_tab(transformed_data, type = "RD"): could not find function "group_tab"