Review package documentation

Review package documentation

package_review(path = ".", config = get_config())

Arguments

path	Path to package
config	Review check configuration

Examples

pkg_path <- system.file("testpkg", package = "docreview")
package_review(pkg_path)
#> 
#> ── docreview results for testpkg ───────────────────────────────────────────────
#> 
#> ── Function Documentation ──
#> 
#> ── Exported functions containing examples in their documentation:  
#> ✔ add
#> ✖ deduct
#> 
#> ── Vignettes ──
#> 
#> ── Flesch Kincaid reading complexity scores 
#> ! testpkg.Rmd: 41.53
#> ! testpkg2.Rmd: 37.28
#> 
#> ── Length scores 
#> ✔ testpkg.Rmd: 382 words.
#> ✔ testpkg2.Rmd: 182 words.
#> 
#> ── Image alt text 
#> Total # images in testpkg.Rmd : 5
#> Total # images in testpkg.Rmd containing alt text: 2
#> ✖ Image 1
#> ✖ Image 2
#> ✔ Image 3
#> ✖ Image 4
#> ✔ Image 5
#> Total # images in testpkg2.Rmd : 0