Learn R Programming

details (version 0.3.0)

use_details: Use details macros

Description

Call this to import the details Rd macro into your package.

  • The RdMacros field of the DESCRIPTION file is updated so you can use the \\foldstart{} and \\foldend{} macro in your documentation.

See the Package Documentation vignette of the details package.

Usage

use_details(desc_path = "./DESCRIPTION")

Arguments

desc_path

character, path to description file to check/edit, Default = './DESCRIPTION'

Details

This will append three elements to the DESCRIPTION file

  • Suggests: details

  • RdMacros: details

  • Roxygen: list(markdown = TRUE)

See Also

details