format_investigator_group_as_flextable: Format an investigator group as a flextable chunk

In steveneschrich/pgreportr: NIH Program Grant Reporting Library

Format an investigator group as a flextable chunk

Description

An investigator group is a tibble of investigators that are considered a grouping, for the purposes of reporting. Examples of groups include an institution, or by Role. The goal of this function is to format this group of investigators into a list of flextable "chunks".

Usage

format_investigator_group_as_flextable(
  investigators,
  label = "",
  label_sep = "\n",
  sep = "\n",
  summary_field = "Investigator Summary",
  ...
)

Arguments

label	A text string or a tibble containing one value
label_sep	Separator between label and investigators (default: newline)
sep	Separator between investigators (default: newline)
i	An investigator tibble

Details

The investigator group (a tibble of related investigators) should be formatted as a list of flextable chunks. A group label can be applied to these investigators, potentially formatted itself.

The label field is an overloaded field. It is either a simple text string representing the name of the group, or a tibble. If it is a tibble, it is expected to contain a single value representing the label to use. The parameter is constructed this way to enable the dplyr::group_map() function to work, since it passes a tibble with the grouped variables.

Value

A flextable chunk representing the group.

steveneschrich/pgreportr documentation built on Jan. 13, 2025, 7:09 p.m.