Skip to contents

Print Preview of a Character Variable into RG

Source: R/03-00-BUILD-RG-DICT.R
paste_preview_chr.Rd

Reads the rg_preview column of the DGF and prints the example values as a wrapped text block (see [wrap_preview()]).

Usage

paste_preview_chr(VNAME, LABEL = "PREVIEW", size = 68, max.lines = 4)

Arguments

VNAME

A character string naming the DGF column to read (the layout passes `"rg_preview"`).

LABEL

A character string for the section title. Defaults to `"PREVIEW"`.

size

Maximum line width, in characters. Defaults to `80`.

max.lines

Maximum wrapped rows to print, which is what keeps the preview to a short strip. Defaults to `4`; the compact guide passes fewer (see `.rail_knobs`).

Value

No return value; prints the preview block to the RG.

Details

Internal to `create_div` in R/03-01-create-sections.R.