Create a contribution paragraph from a contribution table

Usage

contributionParagraph_from_contributorTable(
  x,
  includeMapping = TRUE,
  genericIsPrimary = TRUE,
  mapping = NULL,
  boldAuthors = TRUE,
  output = "markdown",
  quoteParenthesizedItems = TRUE
)

Arguments

x: The contribution table
includeMapping: Whether to include both the specific and the generic item labels (TRUE) or just the item labels for whichever is specified as the primary version (FALSE).
genericIsPrimary: Whether the generic items are primary (and so should show up first, TRUE) or the specific items (FALSE), where the non-primary items are shown in parentheses.
mapping: If the contribution table does not contain an embedded matrix map, the CoMMa specification to map the specific tasks in the contribution tabel onto generic tasks can be specified here, for example as a spreadsheet file (e.g. an .ods file).
boldAuthors: Whether author names should be bold.
output: Whether to produce the contribution paragraph as markdown, as html, or as both (which will be returned in a names list).
quoteParenthesizedItems: Whether to quote the parenthesized items (the specific items by default; TRUE) or not (FALSE0.

Value

The contribution paragraph, as a single character value; or if output = both, a list.

Examples

### Locate the example file
exampleContribTable <-
  system.file(
    "extdata",
    "contributor-matrix---example.ods",
    package = "comma"
  );

### Import the contribution table
contribTable <-
  comma::import_contributorTable(
    exampleContribTable
  );

### Produce the contribution paragrapj
comma::contributionParagraph_from_contributorTable(
  contribTable
);
#> [1] "**PhD Candidate** contributed to Conceptualization ('Defining research goals', 'Exclusion criteria' & 'Query development'), Data curation ('Query execution', 'Grey literature', 'Deduplication', 'Screening' & 'Quality assessment'), Formal Analysis ('Synthesis plans' & 'Synthesis analyses'), Investigation ('Extraction'), Methodology ('First entity draft', 'Entity feedback', 'Entity finalization', 'Screening procedure', 'Search Strategy' & 'Preparing screening packages'), Project administration ('Project-group formation', 'Preregistration', 'Communicating with authors', 'Prepare a presentation' & 'Give a presentation'), Resources ('Data management'), Software ('Query translation', 'Importing and merging of query hits', 'Processing screening results', 'Processing extraction results' & 'Preprocessing'), Validation ('Validating search strategy', 'Validation of screening', 'Validation of extraction' & 'Validation of the synthesis'), Visualization ('Synthesis analyses'), Writing – original draft ('Writing the first manuscript draft'), and to Writing – review & editing ('Reviewing and editing the manuscript'). **Supervisor 1** contributed to Conceptualization ('Defining research goals', 'Exclusion criteria' & 'Query development'), Data curation ('Query execution', 'Grey literature', 'Deduplication', 'Screening' & 'Quality assessment'), Formal Analysis ('Synthesis plans' & 'Synthesis analyses'), Methodology ('First entity draft', 'Entity feedback', 'Entity finalization', 'Screening procedure', 'Search Strategy' & 'Preparing screening packages'), Project administration ('Project-group formation', 'Preregistration', 'Communicating with authors', 'Prepare a presentation' & 'Give a presentation'), Validation ('Validating search strategy', 'Validation of screening', 'Validation of extraction' & 'Validation of the synthesis'), and to Writing – review & editing ('Reviewing and editing the manuscript'). **Supervisor 2** contributed to Conceptualization ('Defining research goals', 'Exclusion criteria' & 'Query development'), Data curation ('Query execution', 'Grey literature', 'Deduplication', 'Screening' & 'Quality assessment'), Formal Analysis ('Synthesis plans' & 'Synthesis analyses'), Methodology ('First entity draft', 'Entity feedback', 'Entity finalization', 'Screening procedure', 'Search Strategy' & 'Preparing screening packages'), Project administration ('Project-group formation', 'Preregistration', 'Communicating with authors', 'Prepare a presentation' & 'Give a presentation'), Validation ('Validating search strategy', 'Validation of screening', 'Validation of extraction' & 'Validation of the synthesis'), and to Writing – review & editing ('Reviewing and editing the manuscript'). **Supervisor 3 (daily supervisor)** contributed to Conceptualization ('Defining research goals', 'Exclusion criteria' & 'Query development'), Formal Analysis ('Synthesis plans' & 'Synthesis analyses'), Methodology ('First entity draft', 'Entity feedback', 'Entity finalization', 'Screening procedure', 'Search Strategy' & 'Preparing screening packages'), Project administration ('Project-group formation', 'Preregistration', 'Communicating with authors', 'Prepare a presentation' & 'Give a presentation'), Resources ('Data management'), Software ('Query translation', 'Importing and merging of query hits', 'Processing screening results', 'Processing extraction results' & 'Preprocessing'), Visualization ('Synthesis analyses'), and to Writing – review & editing ('Reviewing and editing the manuscript')."