Description Usage Arguments Details Examples
Refer directly to .Rd file contents as terminal output.
1 | rdoc_rd(path)
|
path |
character(1), the path to an .Rd file |
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 2 | d <- system.file('extdata/rdoc_test.Rd', package = "rdoc")
rdoc::rdoc_rd(d)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.