rd_describe: RD generator: describe

In mbojan/mbtools: Chaotic Collection of Functions and Datasets Possibly Useful Also To Others

RD generator: describe

Description

Generate RD markup for the definition list via the ⁠\describe⁠ command.

Usage

rd_describe(object, ...)

## Default S3 method:
rd_describe(object, description, ...)

## S3 method for class 'data.frame'
rd_describe(object, ...)

Arguments

object	R object
...	other arguments passed to/from other methods
description	Character vector of term descriptions

Value

Nothing, but RD syntax is cat()ed.

Methods (by class)

• rd_describe(default): The default method expects character vector of "terms" and a character vector description of the same length containing the term descriptions.

• rd_describe(data.frame): Generate a ⁠\describe{}⁠ markup with a list of variable names together with variable labels defined (as in the labelled package).

mbojan/mbtools documentation built on Oct. 16, 2023, 8:18 p.m.