format_creators_as_text: Derive creator name and roles as single text

View source: R/format_creators.R

format_creators_as_textR Documentation

Derive creator name and roles as single text

Description

A creator (investigator, author, presenter) can have a partnership role and a specific role. This function formats the information for output.

Usage

format_creators_as_text(.x, collapse = ", ", ...)

Details

A creator is a person associated with a research product (grant, publication or presentation). There can be one or more creators, and they may have different roles on each product. Additionally, the creator has a partnership role which may change over time. Thus, each research product has a tibble associated with the creators for that work and include descriptions of their name, role in the product (coI, author) and partnership role.

This function produces a text summary of this information so that it could be printed out succinctly. There are many different parameters that can be tweaked (see format_investigator_name for many formatting options passed on through this function).

A creators table has one or more creators using standardized field names (not yet an object, though). Given this table, we convert the fields into a single string (per creator) then consolidate the creators into a single string (using collapse to separate the entries).

The end of result of this function is a single string consolidating the creators in .x.

See Also

format_investigator_name() for flags to format the investigator name.


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