Skip to contents

Bundles consortium study outputs into publication-ready Quarto (.qmd) or Typst (.typ) documents formatted according to target medical journal guidelines (JAMA, Lancet, JAMIA) with automated cross-referencing and an itemized TRIPOD checklist appendix.

Usage

build_manuscript_scaffold(
  title = "Multicenter Federated Health Study",
  study_title = NULL,
  authors = NULL,
  consortium_name = "Federated Health Data Consortium",
  journal = "JAMA",
  target_journal = NULL,
  format = "quarto",
  abstract = NULL,
  tables = NULL,
  table1 = NULL,
  table2 = NULL,
  multivariable_table = NULL,
  iecv = NULL,
  diagnostics = NULL,
  explainability = NULL,
  calibration = NULL,
  dca = NULL,
  output_dir = NULL,
  output_file = NULL
)

Arguments

title

Title of the manuscript.

study_title

Optional alias for title.

authors

Vector or list of author names.

consortium_name

Name of the research network.

journal

Target journal style: "JAMA", "Lancet", "JAMIA", or "Generic".

target_journal

Optional alias for journal.

format

Target format: "quarto" or "typst".

abstract

Structured abstract list or plain text string.

tables

Optional named list of study tables.

table1

Table 1 baseline characteristics data frame or object.

table2

Table 2 participant flow / attrition data frame or object.

multivariable_table

Table 5 risk factors data frame or object.

iecv

Cross-site validation IECV matrix object.

diagnostics

Cohort diagnostics object.

explainability

Explainability summary object.

calibration

Calibration result object.

dca

Decision curve analysis object.

output_dir

Optional directory to write manuscript file.

output_file

Optional explicit file path.

Value

A character string of the complete manuscript document.