{"id":16276405,"url":"https://github.com/sdhutchins/documenter","last_synced_at":"2025-10-04T17:04:31.811Z","repository":{"id":60165444,"uuid":"146833831","full_name":"sdhutchins/documenteR","owner":"sdhutchins","description":"An RStudio addin to create skeleton roxygen2 documentation for functions \u0026 data.frames. ","archived":false,"fork":false,"pushed_at":"2019-05-07T19:02:21.000Z","size":47,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-04T17:04:28.096Z","etag":null,"topics":["document","documentation","r","roxygen","roxygen-skeletons","roxygen2"],"latest_commit_sha":null,"homepage":"http://www.shauritahutchins.com/documenteR/","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/sdhutchins.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}},"created_at":"2018-08-31T02:54:55.000Z","updated_at":"2025-10-04T14:16:38.000Z","dependencies_parsed_at":"2022-09-26T03:40:13.694Z","dependency_job_id":null,"html_url":"https://github.com/sdhutchins/documenteR","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sdhutchins/documenteR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdhutchins%2FdocumenteR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdhutchins%2FdocumenteR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdhutchins%2FdocumenteR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdhutchins%2FdocumenteR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdhutchins","download_url":"https://codeload.github.com/sdhutchins/documenteR/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdhutchins%2FdocumenteR/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278343087,"owners_count":25971400,"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-10-04T02:00:05.491Z","response_time":63,"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":["document","documentation","r","roxygen","roxygen-skeletons","roxygen2"],"created_at":"2024-10-10T18:48:16.417Z","updated_at":"2025-10-04T17:04:31.758Z","avatar_url":"https://github.com/sdhutchins.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Travis build status](https://travis-ci.org/sdhutchins/documenteR.svg?branch=master)](https://travis-ci.org/sdhutchins/documenteR)\n[![Coverage status](https://codecov.io/gh/sdhutchins/documenteR/branch/master/graph/badge.svg)](https://codecov.io/github/sdhutchins/documenteR?branch=master)\n\n# documenteR\n\nAn RStudio addin that builds the skeleton of documentation for an R function or dataframe using roxygen2 syntax.\n\nThis addin has been modified from [@mdlincoln](https://github.com/mdlincoln)'s [docthis](https://github.com/mdlincoln/docthis) to fit more with Hadley's [notes on documenting R packages](http://r-pkgs.had.co.nz/man.html).\n\n\n## Installation\n\n```r\ndevtools::install_github(\"sdhutchins/documenteR\")\n```\n\n## Examples\n\nIF you've witten a function but haven't created documentation for it, select the function tile, and call the \"Document an object\" addin, which will paste in skeleton roxygen2 documentation above your function definition:\n\n### Document a function\n\n```r\n#' @title FUNCTION_TITLE\n#'\n#' @description FUNCTION_DESCRIPTION\n#'\n#' @param formula DESCRIPTION.\n#' @param data DESCRIPTION.\n#' @param subset DESCRIPTION.\n#' @param weights DESCRIPTION.\n#' @param na.action DESCRIPTION.\n#' @param method DESCRIPTION.\n#' @param model DESCRIPTION.\n#' @param x DESCRIPTION.\n#' @param y DESCRIPTION.\n#' @param qr DESCRIPTION.\n#' @param singular.ok DESCRIPTION.\n#' @param contrasts DESCRIPTION.\n#' @param offset DESCRIPTION.\n#' @param ... DESCRIPTION.\n#'\n#' @return RETURN DESCRIPTION\n#' @export\n```\n\n### Document a dataframe\n\nThis will also work for a `data.frame`, which you _should_ be thoroughly documenting in `R/data.R`.\nHighlight the name of your `data.frame` and call the addin.\n\n```r\n#' DATASET_TITLE\n#'\n#' DATASET_DESCRIPTION\n#'\n#' @format A data frame with 150 rows and 5 variables:\n#' \\describe{\n#'   \\item{\\code{Sepal.Length}}{double. DESCRIPTION.}\n#'   \\item{\\code{Sepal.Width}}{double. DESCRIPTION.}\n#'   \\item{\\code{Petal.Length}}{double. DESCRIPTION.}\n#'   \\item{\\code{Petal.Width}}{double. DESCRIPTION.}\n#'   \\item{\\code{Species}}{integer. DESCRIPTION.}\n#' }\n\"iris\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdhutchins%2Fdocumenter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdhutchins%2Fdocumenter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdhutchins%2Fdocumenter/lists"}