check-rd: Check Rd file

Description Usage Arguments Value Examples

Description

Check documentation files to be sure each function have an example and a return value.

Usage

1
2
3
check_Rd_examples(path = "man/", ignore_doc_type = c("data", "package"))

check_Rd_value(path = "man/", ignore_doc_type = c("data", "package"))

Arguments

path

Path to Rd files, typically man/

ignore_doc_type

Ignore specific documentation type. Default is to ignore documentation for datasets and package. Use NULL to cjeck all files.

Value

Character vector of Rd files path.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 

# Check if Rd files have examples
check_Rd_examples()

# Check if Rd files have value (function return)
check_Rd_value()


## End(Not run)

dreamRs/prefixer documentation built on Sept. 14, 2021, 10:50 p.m.