Skip to content
TODOr - RStudio add-in for finding TODO, FIXME, CHANGED etc. comments in your code.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R making r check pass Feb 18, 2019
images readme modified after new commits Nov 26, 2017
inst csv with default patterns added Feb 9, 2018
man making r check pass Feb 18, 2019
tests making r check pass Feb 18, 2019
.Rbuildignore more cran fixes Mar 3, 2019
.gitignore linter changes Oct 3, 2017
DESCRIPTION description spell fix Mar 7, 2019
LICENSE mit license added Feb 9, 2019
NAMESPACE making r check pass Feb 18, 2019
README.md cran info added May 16, 2019
todor.Rproj first version of todor plugin Sep 6, 2017

README.md

TODOr

This is a RStudio addin that finds all TODO, FIXME, CHANGED etc. comments in your project or package and shows them as a markers list.

Installation

Stable release:

install.packages("todor")

The most recent version:

devtools::install_github("dokato/todor")

How to use it?

When you write an R package, sometimes it's useful to note in comments that there is a place for improvement.

simple_function <- function(a, b) {
  # TODO in the future it should be multiplication
  a + b
}

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 "Find package TODOs" or "Find project TODOs") from the list of possible options:

Addins panel

It is also possible to call todor directly from RStudio console:

> todor::todor()

or you can call:

> todor::todor(c("TODO"))

to limit todor detection only to "TODO" tags.

HINT: By default todor works on projects, but you can call todor_package to 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.

TODO Markers

To perform the search on a single file just call:

todor_file("path_to_file.R")

Markdown

You can unlock the markdown search option by setting:

options(todor_rmd=TRUE)

In markdown you probably don't want to use # for comments. But that's okay, as TODOr supports HTML-like comments too.

# Section

<!-- TODO Change this section. -->

* Very important element.

What can it detect?

By default TODOr looks for the following notes:

  • FIXME
  • TODO
  • CHANGED
  • IDEA
  • HACK
  • NOTE
  • REVIEW
  • BUG
  • QUESTION
  • COMBAK
  • TEMP
You can’t perform that action at this time.