Skip to contents

Diagnose Author Identifier Formatting

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

Validates ORCID and ROR identifiers carried in Authors@R person comment fields, mirroring CRAN's bad_ORCID_iDs and bad_ROR_IDs incoming checks. ORCID iDs are checked against their checksum, ROR IDs against their shape.

Usage

lab_identifier_format(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 incoming check run by R CMD check --as-cran NOTEs a malformed ORCID or ROR identifier in Authors@R. 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_identifier_format(pkg, verbose = FALSE)$passed
#> [1] TRUE