Write captions and alternative text — write

Function to create captions and alternative text that contain key quantities from the model results file.

write_captions(dat, dir = getwd(), year = format(Sys.Date(), "%Y"))

write_captions(dat, dir = getwd(), year = format(Sys.Date(), "%Y"))

Arguments

dat: A data frame or names list of data frames (input as `list()`) returned from convert_output. The first data frame in the list is used in calculation of a reference line if one is present
dir: Directory where the output captions and alt text file should be saved. Defaults to working directory.
year: the last year of the data or the current year this function is being performed. Defaults to the current year.

Value

Exports .csv with captions and alt text for figures and tables that contain key quantities (e.g., an assessment's start year) that are automatically extracted from the converted model results file.

Examples

if (FALSE) { # \dontrun{
write_captions(dat,
  dir = getwd(),
  year = 2025
)
} # }
if (FALSE) { # \dontrun{
write_captions(dat,
  dir = getwd(),
  year = 2025
)
} # }