todos: Get TODOs

View source: R/todo.R

todosR Documentation

Get TODOs

Description

Search for #`` TODO tags

Usage

todos(
  pattern = NULL,
  path = ".",
  force = getOption("mark.todos.force", FALSE),
  ...
)

fixmes(
  pattern = NULL,
  path = ".",
  force = getOption("mark.todos.force", FALSE),
  ...
)

Arguments

pattern

A character string containing a regular expression to filter for comments after tags; default NULL does not filter

path

The file directory to search for the tags

force

If TRUE will force searching for files in directories that do not contain an .Rproj file. This can be controlled with the option mark.todos.force

...

Additional parameters passed to grep (Except for pattern, x, and value)

Details

Calls git grep -in "[#] TODO" to find any lines of a .R or .Rmd file with a comment.

Value

NULL if none are found, otherwise a data.frame with the line number, file name, and TODO comment.


mark documentation built on Aug. 7, 2022, 1:05 a.m.

Related to todos in mark...