docr.list: Create an RD list from an R list

In CarlBoneri/roxydoc2: Helps document R packages properly.

Description

docr.list

Usage

docr.list(type = c("ordered", "unordered", "named"), L)

Arguments

type	Type of either: ordered A numbered list unordered(bulleted) A bullet list named A pair list of named objects
L	The list; if pre-constructed

Examples

A <- list(
       Linux = 'server or machine type running in a UNIX/Linux environment',
       Windows = 'Running win-32 or win64 environment',
       `Mac OS` = 'Running MACOS system type'
     )

 # Since all list variables are named, the function defaults to `named`
 # list-type
 > docr.list(L = A)
##' \\describe{
##'   \\item{Linux}{server or machine type running in a UNIX/Linux environment}
##'   \\item{Windows}{Running win-32 or win64 environment}
##'   \\item{Mac OS}{Running MACOS system type}
##' }

> docr.list(L = A, type = "unordered")
##' \\itemize{
##'   \\item server or machine type running in a UNIX/Linux environment
##'   \\item Running win-32 or win64 environment
##'   \\item Running MACOS system type
##' }

> docr.list(L = A, type = "ordered")
##' \enumerate{
##'   \item server or machine type running in a UNIX/Linux environment
##'   \item Running win-32 or win64 environment
##'   \item Running MACOS system type
##' }

CarlBoneri/roxydoc2 documentation built on Nov. 6, 2019, 8:01 a.m.