Generate all sections (title page, acknowledgement, conflict, contribution)

Description

A convenience wrapper that calls the various section generators and combines them into one text block. Ideal for quick copy-paste into Word.

Usage

authordown(
  data,
  title = NULL,
  style = "default",
  show_degree = FALSE,
  acknowledgement_style = "paragraph",
  conflict_style = "paragraph",
  contribution_style = "paragraph"
)

Arguments

Value

A character string containing all sections.

Examples

template_path <- authordown_template()
authors <- authordown_read_local(template_path)
cat(authordown(authors, title = "My Great Paper", style = "default"))

Standardize raw author metadata

Description

Standardize raw author metadata

Usage

authordown_canonicalize(data)

Arguments

Value

A standardized data frame.

Read a local author metadata file

Description

Reads a CSV/TSV/XLSX file and returns a standardized data frame. By default, the data are validated for required columns and basic formats.

Usage

authordown_read_local(path, sheet = NULL, validate = TRUE)

Arguments

Value

A data frame with standardized columns.

Examples

template_path <- authordown_template()
authors <- authordown_read_local(template_path)

Write an authordown input template

Description

Copies a standard author metadata template from the package into the requested path. Use this to start a new project with the expected columns and example values. If path is omitted, a temporary file is used.

Usage

authordown_template(path = NULL, format = NULL)

Arguments

Value

Invisibly returns the output path.

Examples

csv_path <- authordown_template()
xlsx_path <- authordown_template(format = "xlsx")

Validate author metadata

Description

Checks required columns and key formats such as order, email, ORCID, and corresponding author rules.

Usage

authordown_validate(data, require_affiliations = FALSE)

Arguments

Value

The validated, standardized data frame.

Examples

authors <- data.frame(FirstName = "Alice", LastName = "Smith")
authordown_validate(authors)

Generate an Acknowledgement Section (Updated)

Description

Combines acknowledgements provided by the authors into a single, coherent sentence. The function ignores author names (as they are assumed to be included in the acknowledgement text itself) and simply concatenates each non-empty acknowledgement entry using a semicolon.

Usage

generate_acknowledgement(data, style = c("paragraph", "bullets", "numbered"))

Arguments

Value

A character string with the combined acknowledgements.

Examples

authors <- data.frame(
  Acknowledgement = c("This work received support from resource X", 
                      "Resource Y was instrumental", 
                      "Alice Smith received support from resource ZZ"),
  stringsAsFactors = FALSE
)
generate_acknowledgement(authors, style = "paragraph")

Generate a Conflict of Interest Statement

Description

Produces a readable conflict statement. If all authors report no conflict, it states so. Otherwise, it lists the authors reporting conflicts and then indicates that the remaining authors declare no conflict.

Usage

generate_conflict(data, style = c("paragraph", "bullets", "numbered"))

Arguments

Value

A character string with the formatted conflict statement.

Examples

authors <- data.frame(
  FirstName = c("Alice", "Bob"),
  LastName = c("Smith", "Johnson"),
  Conflict = c("No conflict", "Consultant at Company Z"),
  stringsAsFactors = FALSE
)
generate_conflict(authors, style = "paragraph")

Generate Author Contributions

Description

Combines each author's contribution statement into a clear paragraph. Each line indicates the author and their specific contribution.

Usage

generate_contribution(
  data,
  style = c("paragraph", "bullets", "numbered"),
  list_style = NULL
)

Arguments

Value

A character string summarizing the author contributions.

Examples

authors <- data.frame(
  FirstName = c("Alice", "Bob"),
  LastName = c("Smith", "Johnson"),
  Contribution = c("Conceptualization; Data curation", "Supervision; Writing - review"),
  stringsAsFactors = FALSE
)
generate_contribution(authors, style = "paragraph")

Generate a sample CSV template for authordown

Description

Creates a sample CSV (or Excel) with columns for authors, affiliations, acknowledgments, conflicts, etc. If file is omitted, a temporary file is created.

Usage

generate_template(file = NULL, excel = FALSE)

Arguments

Value

Invisibly returns the data frame used for the template.

Examples

generate_template()
generate_template(excel = TRUE)

Generate a Title Page (Journal-Style)

Description

Produces a journal-style title page text with:

1. An optional paper title

2. Author line (with superscript affiliation indices)

3. Affiliation list (labeled by superscript numbers)

4. Co-first author footnote (dagger symbol) if multiple authors share the same minimal rank

5. Corresponding author footnote (*) and contact line

The function expects columns:

• FirstName, MiddleName, LastName (strings)

• Rank (numeric), used to detect co-first authors (lowest rank)

• Correspondence (logical or "TRUE"/"FALSE" string)

• Email (for corresponding authors)

• Affiliation1, Affiliation2, etc. (any number of these)

Usage

generate_title_page(
  data,
  style = c("default", "APA", "Nature"),
  title = NULL,
  show_degree = FALSE,
  co_first_footnote = TRUE
)

Arguments

Value

A single character string suitable for copy-pasting into Word.

Examples

authors <- data.frame(
  FirstName      = c("Alice", "Bob", "Charlie"),
  MiddleName     = c("M.", "", "Q."),
  LastName       = c("Smith", "Johnson", "Lee"),
  Degree         = c("PhD", "MD", "PhD"),
  Email          = c("alice@example.com", "bob@example.com", "charlie@example.org"),
  Rank           = c(1, 1, 2),  # Alice and Bob are co-first authors
  Correspondence = c(TRUE, FALSE, FALSE),
  Affiliation1   = c("University of X, Dept. of Y",
                     "University of X, Dept. of Y",
                     "Institute of Z"),
  Affiliation2   = c(NA, "Company W", NA),
  stringsAsFactors = FALSE
)
cat(generate_title_page(authors, title = "A Great Paper", show_degree = TRUE))

Render a Manuscript Section to HTML

Description

This function takes a section title, a content-generating function, and a data frame, then produces an HTML file that displays the section header and its content. This generic function works for any section (e.g. Conflict of Interest, Author Contributions, Acknowledgements).

Usage

render_section_html(
  section_title,
  content_function,
  data,
  output_file = tempfile(fileext = ".html"),
  ...
)

Arguments

Value

A character string with the path to the rendered HTML file.

Examples

if (requireNamespace("rmarkdown", quietly = TRUE) && rmarkdown::pandoc_available()) {
  template_path <- authordown_template()
  authors <- authordown_read_local(template_path)

  html_path <- render_section_html(
    section_title = "Conflict of Interest",
    content_function = generate_conflict,
    data = authors,
    style = "paragraph"
  )
  if (interactive()) utils::browseURL(html_path)
}