| Title: | Open R help files in RMarkdown format |
|---|---|
| Description: | Open R Help files in RMarkdown format in a new editor tab. Includes an RStudio addin to do this for the current selection or word cursor is on. Compatible with RStudio and VSCode. |
| Authors: | Miles McBain [aut, cre] (YOUR-ORCID-ID) |
| Maintainer: | Miles McBain <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.3 |
| Built: | 2024-08-31 04:35:26 UTC |
| Source: | https://github.com/milesmcbain/rmdocs |
A drop-in replacement for help() that opens the help file as Rmd.
rmd_help(topic, package = NULL)rmd_help(topic, package = NULL)
topic |
bare symbol to search for help on. pkg::func syntax is supported and if used |
package |
package name to resolve symbol in |
You're better off binding this to a key or using the RStudio addin. See README.
nothing. Opens help as side effect.
## Not run: rmd_help(help) ## End(Not run)## Not run: rmd_help(help) ## End(Not run)
Analagous to the default F1 shortcut in RStudio, except it opens the help
for the thing the cursor is on, or is selected, in Rmd format.
rs_rmd_help()rs_rmd_help()
Bind the 'RMarkdown help() on object addin to a keyboard shortcut to use this.
nothing. Opens document as side effect