TODOr - RStudio add-in for finding TODO, FIXME, CHANGED etc. comments in your code.
This is RStudio addin that finds all TODO, FIXME, CHANGED etc. comments in your project or package and shows them as a markers list.
Stable release from CRAN:
The latest version:
devtools::install_github("dokato/todor") # or remotes::install_github("dokato/todor")
When you write an R package, sometimes it's useful to make a note in comments about a place for improvement.
With TODOr, detecting such places in the forest of code lines is simple. There are several options to do so. You can click at "Addins" button in the top panel and select one of the options:
It is also possible to call
todordirectly from RStudio console:
or you can call:
todordetection only to
HINT: By default
todorworks on projects, but you can call
todor_packageto search an entire package.
Regardless of the option that you have chosen, as a result you should see the Markers tab next to your console window in RStudio.
To perform the search on a single file just call:
For more thorough walkthrough check this video-tutorial: https://youtu.be/f4mTYyD2C-8
By default TODOr looks for the following notes: FIXME, TODO, CHANGED, IDEA, HACK, NOTE, REVIEW, BUG, QUESTION, COMBAK, TEMP.
But you may change it by setting
todor_patternsoption, for example:
options(todor_patterns = c("FIXME", "TODO", "CUSTOM"))
In markdown you probably don't want to use
#comments. But that's okay, as
TODOrsupports HTML-like comments too.
You can switch off the markdown search:
options(todor_rmd = FALSE)
Rnwfiles (a default option is set below).
options(todor_rnw = TRUE)
options(todor_rhtml = FALSE)
options(todor_exclude_r = FALSE)
Excluding packrat directory.
options(todor_exclude_packrat = TRUE)
Including extra file formats.
options(todor_extra = c("txt", "dat")) options(todor_extra = NULL)