{"id":14066495,"url":"https://github.com/parmsam/forgot","last_synced_at":"2025-12-30T17:45:57.358Z","repository":{"id":149988432,"uuid":"621004004","full_name":"parmsam/forgot","owner":"parmsam","description":"R package to search for that one function you need in that one package","archived":false,"fork":false,"pushed_at":"2024-11-08T00:18:13.000Z","size":2852,"stargazers_count":13,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-04T06:36:26.421Z","etag":null,"topics":["documentation","functions","package","r","search"],"latest_commit_sha":null,"homepage":"https://parmsam.github.io/forgot/","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/parmsam.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-29T19:54:23.000Z","updated_at":"2024-11-08T00:14:30.000Z","dependencies_parsed_at":"2024-02-19T18:25:45.618Z","dependency_job_id":"61f9ef3c-ad83-44c3-989a-cde9273c9a45","html_url":"https://github.com/parmsam/forgot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/parmsam/forgot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parmsam%2Fforgot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parmsam%2Fforgot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parmsam%2Fforgot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parmsam%2Fforgot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/parmsam","download_url":"https://codeload.github.com/parmsam/forgot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parmsam%2Fforgot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267779970,"owners_count":24143200,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","functions","package","r","search"],"created_at":"2024-08-13T07:05:07.907Z","updated_at":"2025-12-30T17:45:57.306Z","avatar_url":"https://github.com/parmsam.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# forgot \u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"139\" /\u003e\n\n\u003c!-- badges: start --\u003e\n\u003c!-- badges: end --\u003e\n\nThe goal of forgot is to help you search for that one function you need in that one package. This package is based on functions from [Rd2roxygen](https://github.com/yihui/Rd2roxygen). The `forgot()` function returns a tibble of section content in R documentation files from a specified package (that's  already installed). You can search on this tibble and return an interactive HTML table if needed. There's also a RStudio Addin included that you can use to search package documentation in a small Shiny app. `forgot2()` is for more casual use and will return a simple version of the forgot tibble with just the first two columns by default.\n\nThis package provides an alternative to function search without using the help system (`?help()`) in the RStudio IDE. You should still use that though for learning purposes.\n\n## Installation\n\nYou can install the development version of forgot like so:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"parmsam/forgot\")\n```\n\n## Examples\n\nThis are examples which show you how to solve common problems:\n\nCreate a forgot tibble that has columns for doc sections in package functions\n```{r example, eval = T, message = F}\nlibrary(forgot)\nlibrary(dplyr)\n## basic example code\nfunctions_in_pkg \u003c- forgot(\"stringr\")\nfunctions_in_pkg %\u003e% \n  select(function_name, title, desc) %\u003e%\n  head()\n```\n\nSearch for a keyword of interest in the forgot tibble\n```{r}\nforgot(\"stringr\", keyword = \"count\")\n```\n\nOr search for a keyword of interest only on specific fields\n```{r}\nforgot(\"stringr\", keyword = \"count\", selected = c(\"title\", \"desc\"))\n```\n\nIf you want to search across multiple packages, here's an example of how you can use purrr to help with that\n```{r eval = FALSE}\nlibrary(purrr)\nc(\"stringr\", \"dplyr\") %\u003e%\n  purrr::set_names() %\u003e%\n  map(forgot, keyword = \"count\") %\u003e%\n  list_rbind(names_to = \"Package\")\n```\n\nLastly, here's how you can get a reactable HTML table that you can search on\n```{r eval= F}\nforgot(\"stringr\", keyword = \"count\", selected = c(\"title\", \"desc\"),\n               interactive = T)\n```\n\n### Cat a roxygen2 field of interest into your R console\n\nHere's how you can cat (?`cat()` for more info) the parameter field, usage field, or example field. Try it out to see how it looks.\n```{r eval = F}\nforgot_params(\"dplyr\", \"count\")\nforgot_usg(\"dplyr\", \"count\")\nforgot_exmpls(\"dplyr\", \"count\")\n```\nThe write logical (see `forgot_exmpls()` documentation for example) argument will create a new RStudio document with the roxygen2 field content of interest that was cat.\n\n### Shortcuts\n\nYou can also use some shortcut operators to get the same results as above. \n```{r eval = F}\n# shortcut for forgot2\n\"dplyr\" %f2% \"count\"\n## OR\ndplyr %f2% \"count\"\n# shortcut for forgot_usg\n\"dplyr\" %fu% \"count\"\n## OR\ndplyr %fu% count\n# shortcut for forgot_exmpls\n\"dplyr\" %fe% \"count\"\n## OR\ndplyr %fe% count\n\n# shortcut for forgot_params\n\"dplyr\" %fp% \"count\"\n## OR\ndplyr %fp% count\n```\n\n\n## Credits\n\n- Hex icon created using the [hexmake\n  app](https://connect.thinkr.fr/hexmake/) from\n  [ColinFay](https://github.com/ColinFay/hexmake).\n- \u003ca href=\"https://www.flaticon.com/free-icons/confusion\" title=\"confusion icons\"\u003eConfusion icons created by Freepik - Flaticon\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparmsam%2Fforgot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparmsam%2Fforgot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparmsam%2Fforgot/lists"}