Git Product home page Git Product logo

todor's Introduction

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

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")

What can it detect?

By default TODOr looks for the following notes:

  • FIXME
  • TODO
  • CHANGED
  • IDEA
  • HACK
  • NOTE
  • REVIEW
  • BUG
  • QUESTION
  • COMBAK
  • TEMP

todor's People

Contributors

dokato avatar algogym avatar strengejacke avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.