Data

Tools

Indexes

Applications

Experiments

Open Source Science

docreview

An opinionated package for enhancing your R package documentation.

https://github.com/thisisnic/docreview

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.6%) to scientific vocabulary

Keywords

documentation r r-package rstats
Last synced: 6 months ago · JSON representation

Repository

An opinionated package for enhancing your R package documentation.

Basic Info
Statistics
  • Stars: 17
  • Watchers: 1
  • Forks: 1
  • Open Issues: 22
  • Releases: 1
Topics
documentation r r-package rstats
Created almost 5 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.Rmd 

---
output: github_document
---



```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)
```

# docreview 📝🔎


[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/docreview)](https://cran.r-project.org/package=docreview)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![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)
[![codecov](https://app.codecov.io/gh/thisisnic/docreview/branch/main/graph/badge.svg)](https://app.codecov.io/gh/thisisnic/docreview)


_An opinionated package for enhancing your R package documentation._

When writing R packages, high quality documentation can make for a great experience for your users 📦📝🌟🙂

You can use __docreview__ to check that your R package documentation passes a number of checks relating to function documentation and vignette quality. ✅  ✅  ❌

Note 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.

## Installation

You can install docreview from CRAN.

```{r, eval=FALSE}
install.packages("docreview")
```

If you'd like access to the most up-to-date features, you can install the development version from GitHhub. 👩🏽‍🔧

```{r, eval=FALSE}
remotes::install_github("thisisnic/docreview")
```

## Usage

```{r, include = FALSE}
devtools::load_all()

```


```{r, eval = FALSE}
library(docreview)
pkg_path <- system.file("testpkg", package = "docreview")

# ensure you have rebuilt your vignettes if you want to run checks requiring the HTML files
tools::buildVignettes(dir = pkg_path, quiet = TRUE)

# Review docs in the package
package_review(path = pkg_path)
```
```{r, include = FALSE}
devtools::load_all()
pkg_path <- system.file("testpkg", package = "docreview")
package_review(path = pkg_path)
```

See [the vignette](https://thisisnic.github.io/docreview/articles/docreview.html) for more detailed usage guides.

## Current default review checks

CRAN version:

🎯 Vignettes have no more than 2000 words (warn) or 3000 words (fail)

🎯 Vignettes have no fewer than 100 words (warn) or 0 words (fail)

🎯 Vignettes have a Flesch-Kincaid readability score lower than 50 (warn) or 30 (fail)

🎯 All exported functions have examples in their documentation

Additional checks in the dev version:

🎯 All images in vignettes contain alt text

Owner

  • Name: Nic Crane
  • Login: thisisnic
  • Kind: user
  • Location: Lancaster

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 228
  • Total Committers: 1
  • Avg Commits per committer: 228.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Nic Crane t****c@g****m 228

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 43
  • Total pull requests: 15
  • Average time to close issues: 5 days
  • Average time to close pull requests: about 9 hours
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.47
  • Average comments per pull request: 0.07
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • thisisnic (42)
  • spcanelon (1)
Pull Request Authors
  • thisisnic (15)
Top Labels
Issue Labels
enhancement (14) new check (9) documentation (4) CI (4) help wanted (1) good first issue (1) refactor (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 888 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: docreview

Opinionated Documentation Checking

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 888 Last month
Rankings
Stargazers count: 14.6%
Forks count: 28.8%
Average: 28.9%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Downloads: 35.8%
Maintainers (1)
thisisnic@gmail.com
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • cli * imports
  • purrr * imports
  • quanteda * imports
  • quanteda.textstats * imports
  • rlang * imports
  • rmarkdown * imports
  • rvest * imports
  • stringr * imports
  • tools * imports
  • utils * imports
  • yaml * imports
  • knitr * suggests
  • testthat * suggests
inst/pkg_bad_vignettes/DESCRIPTION cran
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
inst/testpkg/DESCRIPTION cran
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/pkgdown.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/r-cmd-check-cran.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/r-lib-checks.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/testcoverage.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite