Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.41 KB

README.md

File metadata and controls

32 lines (21 loc) · 1.41 KB
Raw

An RStudio addin for roxygen2 code blocks

Build Status CRAN

RStudio addins let you execute a bit of R code or a Shiny app through the RStudio IDE, either via the Addins dropdown menu or with a keyboard shortcut. This package contains an RStudio addin for commenting roxygen2 code.

This package can be installed via

devtools::install_github("csgillespie/roxygen2Comment")

Running addins

After installing the package, the Addins menu toolbar will be populated with the new, exported addin. The addin will work exactly like the RStudio keyboard shortcut for commenting.

  • If you execute the addin on standard code, it will add #' to the start of the line.
  • If you execute the addin on an roxygen2 comment, it will remove #'

Manage your addins

See my other package for conviently adding and removing RStudio addins.

Other information

  • If you have any suggestions or find bugs, please use the github issue tracker.
  • Feel free to submit pull requests for new addins.