Skip to contents

The function generates rmarkdown formatted contributors' affiliation text from an contributors_table. 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.

Usage

print_title_page(contributors_table, text_format = "rmd")

Arguments

contributors_table

validated contributors_table

text_format

formatting of the returned string. Possible values: "rmd", "html", "raw". "rmd" by default.

Value

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.

Warning

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.

See also

Examples

example_contributors_table <- read_contributors_table(
contributors_table = system.file("extdata",
"contributors_table_example.csv", package = "tenzing", mustWork = TRUE))
#> Rows: 3 Columns: 26
#> ── Column specification ────────────────────────────────────────────────────────
#> Delimiter: ","
#> chr  (9): Firstname, Middle name, Surname, Affiliation 1, Affiliation 2, Aff...
#> dbl  (1): Order in publication
#> lgl (16): Conceptualization, Data curation, Formal analysis, Funding acquisi...
#> 
#>  Use `spec()` to retrieve the full column specification for this data.
#>  Specify the column types or set `show_col_types = FALSE` to quiet this message.
print_title_page(contributors_table = example_contributors_table)
#> John M. Smith^1,2*†^, Marton Kovacs^1,3,4*^, Lex W. Luthor^2,5^
#>    
#> ^1^Institute of Psychology, ELTE Eotvos Lorand University, Budapest, Hungary, Doctoral School of Psychology, ^2^LexCorp, Smallville, Kansas, US, ^3^Department of Psychology, ^4^Institute for Interstellar Relations, Oxbridge University, UK, ^5^Metropolis University                       
#>    
#> *John M. Smith and Marton Kovacs are shared first authors. ^†^ Correspondence should be addressed to John M. Smith; E-mail: some@email.com.