caption: Captions for Figures and Tables

In trinker/reports: An R Package to Assist in the Workflow of Writing Academic Articles and Other Reports

Description

caption - Keep track of numbering for table and figure captions.

caption_figure - Keep track of numbering for figure captions.

caption_table - Keep track of numbering for table captions.

Usage

cap(type = 1, label, caption, style = "margin-bottom: 3em;",
  copy2clip = interactive(), print = FALSE, spaces = 2)

caption_figure(label, caption, style = "margin-bottom: 3em;",
  copy2clip = interactive(), print = FALSE)

caption_table(label, caption, style = "margin-top: 4em;",
  copy2clip = interactive(), print = FALSE, spaces = 2)

Arguments

type	Either "figure" or "table" or accompanying numeric reference: figure = 1, table = 2.
label	A hyperlink reference label.
caption	A caption to place below/above a figure/table.
style	Additional style elements to be passed to the html p tag.
copy2clip	logical. If TRUE attempts to copy the output to the clipboard.
print	logical. If TRUE cat prints the output to the console. If FALSE returns to the console.
spaces	An integer value dictating the number of lines to skip after the table caption header.

Value

Returns a character vector of a caption.

Examples

caption_figure("fig1", "A random figure.")
caption_table("tab1", "A table")

trinker/reports documentation built on May 31, 2019, 9:51 p.m.