plot_caption: Make and Save a Figure Caption

In nwfsc-assess/VAST_WestCoast: Estimation and simulation with VAST for the US West Coast

Make and Save a Figure Caption

Description

Take input text and generate a standardized csv file with a caption for a given figure.

Usage

plot_caption(text, survey, figname, savefile)

Arguments

text	A text string of any length pasted together into a single string.
survey	A character value supplying the survey name. The value is typically an acronym. See createMatrix() for a list of defaults.
figname	A character value that will be pasted together along with the survey name to generate the label used in the Latex file or markdown file. For example entries of figname = "mesh" and survey = "Triennial" would lead to a label of "fig_mesh_Triennial".
savefile	The file name that you want the results saved to. A full path can be specified, else the file will be saved in the current directory.

Value

The resulting data frame with the label and the caption as column entries with a single row for the given figure. The data frame is also saved to the disk using the file name in savefile.

nwfsc-assess/VAST_WestCoast documentation built on July 4, 2023, 5:45 p.m.