https://github.com/csgillespie/roxygen2comment

An Rstudio addin for adding and remove roygen2 comment
https://github.com/csgillespie/roxygen2comment

Last synced: 3 months ago
JSON representation

An Rstudio addin for adding and remove roygen2 comment

• Host: GitHub
• URL: https://github.com/csgillespie/roxygen2comment
• Owner: csgillespie
• Created: 2016-04-16T16:44:30.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-03-14T10:30:48.000Z (about 4 years ago)
• Last Synced: 2025-03-01T00:18:35.676Z (3 months ago)
• Language: R
• Homepage:
• Size: 5.86 KB
• Stars: 27
• Watchers: 1
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

        
---

output:

  md_document:

    variant: markdown_github

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

# An RStudio addin for roxygen2 code blocks

[![Build Status](https://travis-ci.org/csgillespie/roxygen2Comment.png?branch=master)](https://travis-ci.org/csgillespie/roxygen2Comment) 

[![CRAN](http://www.r-pkg.org/badges/version/roxygen2Comment)](http://cran.rstudio.com/package=roxygen2Comment)

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

```{r eval=FALSE}

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](https://github.com/csgillespie/addinmanager) 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.