fold: Roxygen2 Documentation Folding

In details: Create Details HTML Tag for Markdown and Package Documentation

Roxygen2 Documentation Folding

Description

Insert more information to function documentation without overwhelming the user by using foldstart and foldend macros.

Usage

foldstart(title = NULL)

foldend()

Arguments

title

Title of the folded section, Default: NULL

Details

To enable this feature add to the DESCRIPTION file before rendering the roxygen2:

Roxygen: list(markdown = TRUE)

Value

character

Examples

# With title

 "#' \foldstart{This is an example}
 
  #' DOCUMENTATION
 
  #' \foldend"


# With no title

 "#' \foldstart{}
 
  #' DOCUMENTATION
 
  #' \foldend"
 

details documentation built on March 28, 2022, 1:06 a.m.