fmt_luminex_results: Conditionally formats a worksheet based on data within the...

Description Usage Arguments Value

View source: R/fmt_luminex_results.R

Description

This function is used for it's side effects. It takes an Excel workbook (excel_file), a list of dataframes (df_list), an index (fmtIndexNum) to the dataframe list to indicate the dataframe to be used for conditional formating, an index (wrkSheetIndex) to the dataframe list to indicate the dataframe to be written into the workbook and then the formatting will be applied to it, the worksheet name (sheet_name) of the worksheet being written, and the dataframe containing values for the low positive controls (low_positive_controles_df)

Usage

1
2
3
4
5
6
7
8
fmt_luminex_results(
  excel_file,
  df_list,
  fmtIndexNum,
  wrkSheetIndex,
  sheet_name = "final_result",
  low_positive_controls_df
)

Arguments

excel_file

character vector with the name of the Excel file

df_list

List of dataframes used as the source data for formating and for writing the Excel file worksheet. The two (data controlling formating and data written) may not be the same.

fmtIndexNum

Index into the list of dataframes (df_list used to guide format highlighting.

wrkSheetIndex

Index into the list of dataframes (df_list used to write the data into the worksheet.

sheet_name

name of the worksheet to be written and highlighted.

low_positive_controls_df

dataframe with the low positive controls

Value

Excel file name of file that has been formatted to highlight non-negative results in the sheet indicated. This highlights "I" and "P" results


rmsharp/snprcspf documentation built on June 15, 2020, 11:21 a.m.