Skip to contents

Diagnose the Authors@R Field

Source: R/diagnostics-description.R
lab_authors.Rd

Flags a missing Authors@R, and an unfilled usethis template such as person("First", "Last", ...), which is a hard CRAN rejection that R CMD check says nothing about.

Usage

lab_authors(path = ".", verbose = TRUE, desc = NULL)

Arguments

path

Character. Path to the package directory. Default: ".".

verbose

Logical. Print diagnostic output. Default: TRUE.

desc

Optional pre-parsed DESCRIPTION, as returned by base::read.dcf(). Defaults to reading it from path.

Value

checktor_check_result() with passed, issues, message.

Source

The CRAN Repository Policy treats a placeholder or malformed Authors@R, including a missing maintainer, as a rejection. See vignette("check-sources", package = "checktor") for how every check maps to its source.

See also

checktor(), which runs this and every other check.

Examples

pkg <- example_diagnose_scenario("code_examples/tf_usage_bad.R",
                                 show_content = FALSE)
lab_authors(pkg, verbose = FALSE)$passed
#> [1] TRUE