Deterministic graphical abstract specifications — graphical-abstract • popgenVCF

Creates, validates, and writes deterministic graphical-abstract assembly specifications without altering canonical scientific assets.

Usage

new_graphical_abstract(manuscript, panels = list(), title = NULL,
  message = NULL, alt_text = NULL, width_px = 1800L,
  height_px = 1000L, resolution_dpi = 300L,
  orientation = c("landscape", "portrait", "square"),
  background = "white")

validate_graphical_abstract(x, strict = TRUE)

write_graphical_abstract(graphical_abstract, directory,
  overwrite = FALSE, strict = FALSE)

Arguments

manuscript: A canonical PopgenVCFManuscript object.
panels: Ordered panel records containing immutable artifact identities and existing file paths.
title: Author-supplied graphical abstract title.
message: Author-supplied central message.
alt_text: Author-supplied accessibility description.
width_px, height_px: Target pixel dimensions.
resolution_dpi: Target resolution in dots per inch.
orientation: Target landscape, portrait, or square orientation.
background: Background description.
x: A graphical abstract specification to validate.
strict: Whether missing author inputs are errors.
graphical_abstract: A PopgenVCFGraphicalAbstract object.
directory: Parent output directory.
overwrite: Whether an existing output directory may be replaced.

Value

new_graphical_abstract() returns a PopgenVCFGraphicalAbstract object. Validation returns TRUE invisibly. Writing returns the normalized output directory invisibly.