generateEnumeration {wyz.code.rdoc}

Generate Enumeration

Description

Generate enumeration for R documentation

Usage

generateEnumeration(entries_s, itemize_b_1 = FALSE)

Arguments

entries_s

An unconstrained vector of strings

itemize_b_1

A single boolean value

Value

A special character vector to mimic either enumerate or itemize accordingly to R documentation specification.

Set itemize_b_1 to TRUE if you want an item list, instead of an enumeration.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

Examples

generateEnumeration(LETTERS[1:3])
# [1] "\enumerate{\item  A\n\item  B\n\item  C}"

generateEnumeration(LETTERS[1:3], TRUE)
# [1] "\itemize{\item  A\n\item  B\n\item  C}"