report_auth: Generate a formatted authorship list.

In kamclean/collaborator: Scalable multi-centre research using R and REDCap

Generate a formatted authorship list.

Description

Used to generate a formatted authorship list for all users by group (the group the user belongs to e.g. the centre which they participated at). Optional subdivisions can be created to stratify users and groups. This could be a role (e.g. collaborator and validator) or region/country.

Usage

report_auth(
  df,
  name,
  group = NULL,
  subdivision = NULL,
  path = NULL,
  name_sep = ", ",
  group_brachet = "()",
  group_sep = "; "
)

Arguments

df	Dataframe with authors in rows.
group	Column name of a variable in the dataframe by which to group authorship (the default is NULL).
subdivision	Column name of an additional variable in the dataframe by which to subdivide authorship (the default is NULL).
path	Path or connection to write to as .txt file.
name_sep	Character(s) which will separate names within the group (the default is ", ").
group_brachet	Character(s) bracheting the group (the default is "()").
group_sep	Character(s) which will separate the groups (the default is "; ").

Value

Returns a formated string (and an optional .txt file specified using path)

kamclean/collaborator documentation built on Nov. 17, 2023, 3:52 a.m.