fold: Roxygen2 Documentation Folding

Description Usage Arguments Details Value Examples

Description

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

Usage

1
2
3

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# With title

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


# With no title

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

details documentation built on Jan. 12, 2020, 6:19 p.m.