todor: TODOR This package helps you to find all code rows in your code with places to be filled in the future.

Description

Called on project that are not R packages. Checks all places in the code which require amendents as specified in todo_types on R and r files. It triggers rstudio markers to appear.

Usage

todor(
  todo_types = NULL,
  search_path = getwd(),
  file = NULL,
  output = "markers"
)

Arguments

todo_types

vector with character describing types of elements to detect. If NULL default items will be used.

search_path

vector with paths that contains comments you are looking for.

file

character with path to file. If not NULL the search_path will be ignored.

output

what form should the output take? "markers" (default) creates a marker for each TODO and lists them in the "Markers" Rstudio pane. "text" coverts the TODO list to markdown syntax

Details

There are several options that let you control TODOr behaviour:

todor_rmd - when set to TRUE it searches also through Rmd files (default TRUE).

todor_rnw - when set to TRUE it searches also through Rnw files (default FALSE).

todor_rhtml - when set to TRUE it searches also through Rhtml files (default FALSE).

todor_exclude_packrat when set to FALSE, all files in the "packrat" directory are excluded (default TRUE).

todor_exclude_r when TRUE, it ignores R and r files (default FALSE)

todor_patterns must be vector. Contains all the names of patterns to be detected. Default are: "FIXME", "TODO", "CHANGED", "IDEA", "HACK", "NOTE", "REVIEW", "BUG", "QUESTION", "COMBAK", "TEMP".