format_creators: Format creators of various types

In steveneschrich/pgreportr: NIH Program Grant Reporting Library

Format creators of various types

Description

Creators exist across different reporting types, such as grants (investigators), publications (authors) and presentations (presenters, co-authors). These are all considered as creators and much of the code associated with formatting the list of these creators is the same.

Details

Creators can be investigators, authors or presenters depending on the research product. In any of these cases, however, the formatting is similar if not identical.

First, it is important to remember that a grant, publication or presentation table consist of lists of creators. That is grant "A" has an investigator table unique to this grant. Grant "B" also has a unique investigator table. Thus, when calling format_authors(), format_presenters() or format_investigators(), we should expect a list of tables representing different research products.

From a list of tables, a formatting function is used to format the creators within a research product as a single entity. Currently, this could be text or a flextable "chunk". A set of functions (format_authors_as_..., format_presenters_as_..., format_investigators_as_...) expect a table of creators which are then formatted individually (format_author_as_..., format_presenters_as_..., format_investigators_as_...) and combined.

The approach taken for formatting creators is generally as follows (considering the creator type author):

• format_authors(authors_list, author_formatting_function)

• format_authors_as_flextable?

• format_authors_as_text()

• format_author_as_text()

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