rdoc (version 0.1.0)

rdoc_style: rdoc style options

Description

Set Rd output formatting styles to be supplied to options(rdoc.style = rdoc_style())

Usage

rdoc_style(title = crayon::bold, section_titles = crayon::underline,
  arguments = NULL, code_style = prettycode::default_style())

Arguments

title

topic title.

section_titles

section titles

arguments

argument parameters.

code_style

code sections (e.g. examples) and inline code styles to be passed on to prettycode::highlight

Value

A list

Details

all inputs should be functions or NULL with the exception of code_style which should be a list of functions.

Examples

# NOT RUN {
options(rdoc.style = rdoc::rdoc_style(arguments = crayon::italic))
# }