The function generates rmarkdown formatted contributors' affiliation text from
an contributors_table validated with the validate_contributors_table() function. The
contributors_table must be based on the contributors_table_template(). The function can
return the output string as rmarkdown or html formatted text or without any formatting.
print_title_page(contributors_table, text_format = "rmd")
| contributors_table | validated contributors_table |
|---|---|
| text_format | formatting of the returned string. Possible values: "rmd", "html", "raw". "rmd" by default. |
The output is string containing the contributors' name and
the corresponding affiliations in the the order defined by the
Order in publication column of the contributors_table.
The function is primarily developed to be the part of a shiny app. As the validation is handled inside of the app separately, the function can break with non-informative errors if running locally without first validating it.
Other output functions:
print_credit_roles(),
print_funding(),
print_xml(),
print_yaml()
example_contributors_table <- read_contributors_table( contributors_table = system.file("extdata", "contributors_table_example.csv", package = "tenzing", mustWork = TRUE))#>#> #> #> #> #>#> #> #>#> $missing_surname #> $missing_surname$type #> [1] "success" #> #> $missing_surname$message #> [1] "There are no missing surnames." #> #> #> $missing_firstname #> $missing_firstname$type #> [1] "success" #> #> $missing_firstname$message #> [1] "There are no missing firstnames." #> #> #> $duplicate_names #> $duplicate_names$type #> [1] "success" #> #> $duplicate_names$message #> [1] "There are no duplicate names in the contributors_table." #> #> #> $duplicate_initials #> $duplicate_initials$type #> [1] "success" #> #> $duplicate_initials$message #> [1] "There are no duplicate initials in the contributors_table." #> #> #> $missing_order #> $missing_order$type #> [1] "success" #> #> $missing_order$message #> [1] "There are no missing values in the order of publication." #> #> #> $duplicate_order #> $duplicate_order$type #> [1] "success" #> #> $duplicate_order$message #> [1] "There are no duplicated order numbers in the contributors_table." #> #> #> $missing_affiliation #> $missing_affiliation$type #> [1] "success" #> #> $missing_affiliation$message #> [1] "There are no missing affiliations in the contributors_table." #> #> #> $missing_corresponding #> $missing_corresponding$type #> [1] "success" #> #> $missing_corresponding$message #> [1] "There is at least one author indicated as corresponding author." #> #> #> $missing_credit #> $missing_credit$type #> [1] "success" #> #> $missing_credit$message #> [1] "All authors have at least one CRediT statement checked." #> #> #> $missing_email #> $missing_email$type #> [1] "success" #> #> $missing_email$message #> [1] "There are email addresses provided for all corresponding authors." #> #>print_title_page(contributors_table = example_contributors_table)#> Alex O. Holcombe^1*^, Marton Kovacs^2,3*^, Balazs Aczel^2^, Frederik Aust^4,5^, Julien Colomb^6^ #> #> ^1^University of Sydney, ^2^Institute of Psychology, ELTE Eotvos Lorand University, Budapest, Hungary, ^3^Doctoral School of Psychology, ELTE Eotvos Lorand University, Budapest, Hungary, ^4^University of Cologne, Cologne, Germany, ^5^University of Amsterdam, Amsterdam, Netherlands, ^6^Humboldt University of Berlin #> #> *Alex O. Holcombe and Marton Kovacs are shared first authors. The corresponding author is Marton Kovacs: marton.balazs.kovacs@gmail.com.