{"id":22303638,"url":"https://github.com/thisisnic/docreview","last_synced_at":"2025-07-29T04:31:15.363Z","repository":{"id":47602696,"uuid":"369618875","full_name":"thisisnic/docreview","owner":"thisisnic","description":"An opinionated package for enhancing your R package documentation.","archived":false,"fork":false,"pushed_at":"2024-02-19T17:03:09.000Z","size":683,"stargazers_count":18,"open_issues_count":22,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-02-20T17:55:47.282Z","etag":null,"topics":["documentation","r","r-package","rstats"],"latest_commit_sha":null,"homepage":"https://thisisnic.github.io/docreview/","language":"HTML","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/thisisnic.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-05-21T18:13:38.000Z","updated_at":"2024-02-19T16:12:07.000Z","dependencies_parsed_at":"2024-02-19T17:36:34.056Z","dependency_job_id":"3fce317b-47f0-4440-a162-ee4e435a7ef1","html_url":"https://github.com/thisisnic/docreview","commit_stats":{"total_commits":228,"total_committers":1,"mean_commits":228.0,"dds":0.0,"last_synced_commit":"aa96f51d1122c87b322475c8557aa47f91243612"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thisisnic%2Fdocreview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thisisnic%2Fdocreview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thisisnic%2Fdocreview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thisisnic%2Fdocreview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thisisnic","download_url":"https://codeload.github.com/thisisnic/docreview/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227978835,"owners_count":17850664,"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":["documentation","r","r-package","rstats"],"created_at":"2024-12-03T18:44:25.134Z","updated_at":"2024-12-03T18:44:25.638Z","avatar_url":"https://github.com/thisisnic.png","language":"HTML","funding_links":[],"categories":[],"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 setup, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\"\n)\n```\n\n# docreview 📝🔎\n\n\u003c!-- badges: start --\u003e\n[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/docreview)](https://cran.r-project.org/package=docreview)\n[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)\n[![R-CMD-check](https://github.com/thisisnic/docreview/workflows/R-CMD-check/badge.svg)](https://github.com/thisisnic/docreview/actions?query=workflow%3AR-CMD-check)\n[![codecov](https://app.codecov.io/gh/thisisnic/docreview/branch/main/graph/badge.svg)](https://app.codecov.io/gh/thisisnic/docreview)\n\u003c!-- badges: end --\u003e\n\n_An opinionated package for enhancing your R package documentation._\n\nWhen writing R packages, high quality documentation can make for a great experience for your users 📦📝🌟🙂\n\nYou can use __docreview__ to check that your R package documentation passes a number of checks relating to function documentation and vignette quality. ✅  ✅  ❌\n\nNote that this package is in *very* early stages of its development and features are not yet stable, and so the package may undergo significant changes.  If you plan to use it as part of a workflow, please be aware that new releases are very likely to introduce breaking changes to the config files, and so use the package (and any updates) with caution.\n\n## Installation\n\nYou can install docreview from CRAN.\n\n```{r, eval=FALSE}\ninstall.packages(\"docreview\")\n```\n\nIf you'd like access to the most up-to-date features, you can install the development version from GitHhub. 👩🏽‍🔧\n\n```{r, eval=FALSE}\nremotes::install_github(\"thisisnic/docreview\")\n```\n\n## Usage\n\n```{r, include = FALSE}\ndevtools::load_all()\n\n```\n\n\n```{r, eval = FALSE}\nlibrary(docreview)\npkg_path \u003c- system.file(\"testpkg\", package = \"docreview\")\n\n# ensure you have rebuilt your vignettes if you want to run checks requiring the HTML files\ntools::buildVignettes(dir = pkg_path, quiet = TRUE)\n\n# Review docs in the package\npackage_review(path = pkg_path)\n```\n```{r, include = FALSE}\ndevtools::load_all()\npkg_path \u003c- system.file(\"testpkg\", package = \"docreview\")\npackage_review(path = pkg_path)\n```\n\nSee [the vignette](https://thisisnic.github.io/docreview/articles/docreview.html) for more detailed usage guides.\n\n## Current default review checks\n\nCRAN version:\n\n🎯 Vignettes have no more than 2000 words (warn) or 3000 words (fail)\n\n🎯 Vignettes have no fewer than 100 words (warn) or 0 words (fail)\n\n🎯 Vignettes have a Flesch-Kincaid readability score lower than 50 (warn) or 30 (fail)\n\n🎯 All exported functions have examples in their documentation\n\nAdditional checks in the dev version:\n\n🎯 All images in vignettes contain alt text\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthisisnic%2Fdocreview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthisisnic%2Fdocreview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthisisnic%2Fdocreview/lists"}