Description Usage Arguments Details Examples
Refer to colourised R docs as terminal output. Provides a
replacement for ?
. Meant primarily for use as an
override in use_rdoc()
1 | rdoc_question(type, topic)
|
type |
the special type of documentation to use for this topic;
for example, if the type is |
topic |
Usually, a name or character string specifying the topic for which help is sought. Alternatively, a function call to ask for documentation on a
corresponding S4 method: see the section on S4 method documentation.
The calls |
The manner in which content is outputted depends on where it is
being used. If used from a terminal the contents will be outputted via
file.show
. Otherwise the output will be printed interactively by
sections unless this has been disabled via options(rdoc.by_section =
FALSE)
. When printing by section pressing the <enter> keypress will show
the next section. Any other keypress will exit the interaction without
printing any remaining sections. Color support is checked via
crayon::has_color()
. Customising rdoc output is possible via
'options', see rdoc_options
for more details.
1 | rdoc::rdoc_question('lapply')
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.