Need help with todor?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

dokato
164 Stars 9 Forks Other 112 Commits 5 Opened issues

Description

TODOr - RStudio add-in for finding TODO, FIXME, CHANGED etc. comments in your code.

Services available

!
?

Need anything else?

Contributors list

# 216,777
R
shiny
Shell
Jupyter...
74 commits
# 492,757
R
Shell
depende...
markers
6 commits
# 704,673
R
rstudio
markers
3 commits
# 600,529
R
XML
Shell
rna-seq
2 commits
# 93,638
R
statsmo...
TeX
Shell
1 commit

TODOr

cranlogs total R-CMD-check <!-- Coverage Status -->

This is 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 from CRAN:

install.packages("todor")

The latest version:

devtools::install_github("dokato/todor")
# or
remotes::install_github("dokato/todor")

How to use it?

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

simple_function 

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:

  • "Find active file TODOs" (for the active file in RStudio editor)
  • "Find package TODOs" (if you are creating package)
  • "Find project TODOs" (if you are inside the RStudio project)

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::todor_file("path_to_file.R")

For more thorough walkthrough check this video-tutorial: https://youtu.be/f4mTYyD2C-8

What can it detect?

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_patterns
option, for example:
options(todor_patterns = c("FIXME", "TODO", "CUSTOM"))

Markdown

In markdown you probably don't want to use

#
comments. But that's okay, as
TODOr
supports HTML-like comments too.
# Section



  • Very important element.

You can switch off the markdown search:

options(todor_rmd = FALSE)

Other options

Searching through

Rnw
files (a default option is set below).
options(todor_rnw = TRUE)

Searching through

Rhtml
files.
options(todor_rhtml = FALSE)

Searching through

R
,
r
files.
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)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.