Roxygen2 Documentation Folding

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

foldstart(title = NULL)

foldend()

Arguments

title

Title of the folded section, Default: NULL

Value

character

Details

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

Roxygen: list(markdown = TRUE)

Examples

# With title

 "#' \foldstart{This is an example}
 
  #' DOCUMENTATION
 
  #' \foldend"
#> [1] "#' \foldstart{This is an example}\n \n  #' DOCUMENTATION\n \n  #' \foldend"


# With no title

 "#' \foldstart{}
 
  #' DOCUMENTATION
 
  #' \foldend"
#> [1] "#' \foldstart{}\n \n  #' DOCUMENTATION\n \n  #' \foldend"