{"id":14069008,"url":"https://github.com/dokato/todor","last_synced_at":"2025-04-07T15:11:14.375Z","repository":{"id":48738457,"uuid":"102619493","full_name":"dokato/todor","owner":"dokato","description":"TODOr - RStudio add-in for finding TODO, FIXME, CHANGED etc. comments in your code.","archived":false,"fork":false,"pushed_at":"2023-12-03T15:04:36.000Z","size":448,"stargazers_count":253,"open_issues_count":9,"forks_count":12,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-31T13:18:44.311Z","etag":null,"topics":["addins","markers","r","rstudio"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dokato.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-09-06T14:34:57.000Z","updated_at":"2025-03-22T08:13:39.000Z","dependencies_parsed_at":"2023-12-03T16:21:38.204Z","dependency_job_id":"8e5948f1-d9f5-4f3d-959d-18a7228d3c2e","html_url":"https://github.com/dokato/todor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokato%2Ftodor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokato%2Ftodor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokato%2Ftodor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dokato%2Ftodor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dokato","download_url":"https://codeload.github.com/dokato/todor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247675609,"owners_count":20977378,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addins","markers","r","rstudio"],"created_at":"2024-08-13T07:06:32.529Z","updated_at":"2025-04-07T15:11:14.356Z","avatar_url":"https://github.com/dokato.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# TODOr\n\n\u003cimg src=\"images/hexstick.png\" align=\"right\" alt=\"\" width=\"150\" /\u003e\n\n[![CRAN status](https://www.r-pkg.org/badges/version/todor)](https://cran.r-project.org/package=todor)\n[![cranlogs](https://cranlogs.r-pkg.org/badges/todor)](https://CRAN.R-project.org/package=todor)\n[![total](https://cranlogs.r-pkg.org/badges/grand-total/todor)](https://CRAN.R-project.org/package=todor)\n[![R-CMD-check](https://github.com/dokato/todor/workflows/R-CMD-check/badge.svg)](https://github.com/dokato/todor/actions)\n\u003c!-- [![Coverage Status](https://coveralls.io/repos/github/dokato/todor/badge.svg?branch=master)](https://coveralls.io/github/dokato/todor?branch=master) --\u003e\n\nThis is RStudio addin that finds all **TODO**, **FIXME**, **CHANGED** etc. comments in your **project** or **package** and shows them as a markers list.\n\n# Installation\n\nStable release from CRAN:\n\n```r\ninstall.packages(\"todor\")\n```\n\nThe latest version:\n\n```r\ndevtools::install_github(\"dokato/todor\")\n# or\nremotes::install_github(\"dokato/todor\")\n```\n\n\n# How to use it?\n\nWhen you write an R package, sometimes it's useful to make a note in comments about a place for improvement.\n\n```r\nsimple_function \u003c- function(a, b) {\n  # TODO in the future check the type of input here\n  a + b\n}\n```\n\nWith **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:\n\n- *\"Find active file TODOs\"* (for the active file in RStudio editor)\n- *\"Find package TODOs\"* (if you are creating package)\n- *\"Find project TODOs\"* (if you are inside the RStudio project)\n\n![Addins panel](images/pic1.png)\n\nIt is also possible to call `todor` directly from RStudio console:\n\n```r\n\u003e todor::todor()\n```\n\nor you can call:\n\n```r\n\u003e todor::todor(c(\"TODO\"))\n```\n\nto limit `todor` detection only to `\"TODO\"` tags.\n\n**HINT:** By default `todor` works on projects, but you can call `todor_package` to search an entire package.\n\nRegardless of the option that you have chosen, as a result you should see the Markers tab next to your console window in RStudio.\n\n![TODO Markers](images/pic2.png)\n\nTo perform the search on a single file just call:\n\n```r\n\u003e todor::todor_file(\"path_to_file.R\")\n```\n\nFor more thorough walkthrough check this video-tutorial: https://youtu.be/f4mTYyD2C-8\n\n# What can it detect?\n\nBy default *TODOr* looks for the following notes: _FIXME_, _TODO_, _CHANGED_, _IDEA_, _HACK_, _NOTE_, _REVIEW_, _BUG_, _QUESTION_, _COMBAK_, _TEMP_.\n\nBut you may change it by setting `todor_patterns` option, for example:\n\n```r\noptions(todor_patterns = c(\"FIXME\", \"TODO\", \"CUSTOM\"))\n```\n\n### Markdown\n\nIn markdown you probably don't want to use `#` comments. But that's okay, as `TODOr` supports HTML-like comments too.\n\n```md\n# Section\n\n\u003c!-- TODO Change this section. --\u003e\n\n* Very important element.\n```\n\nYou can switch off the markdown search:\n\n```r\noptions(todor_rmd = FALSE)\n```\n\n# Other options\n\nSearching through `Rnw` files (a default option is set below).\n\n```r\noptions(todor_rnw = TRUE)\n```\n\nSearching through `Rhtml` files.\n\n```r\noptions(todor_rhtml = FALSE)\n```\n\nSearching through `R`, `r` files.\n\n```r\noptions(todor_exclude_r = FALSE)\n```\n\nExcluding packrat directory.\n\n```r\noptions(todor_exclude_packrat = TRUE)\n```\n\nIncluding extra file formats.\n\n```r\noptions(todor_extra = c(\"txt\", \"dat\"))\noptions(todor_extra = NULL)\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokato%2Ftodor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdokato%2Ftodor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdokato%2Ftodor/lists"}