Skip to contents

Diagnose the DESCRIPTION Version Field

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

Flags a Version with a leading-zero component or a suspiciously large one, mirroring CRAN's version_with_leading_zeroes and version_with_large_components incoming checks. A calendar-year component (e.g. a dated 2026.01 version) is exempt.

Usage

lab_version_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

Writing R Extensions, under "The DESCRIPTION file", says a Version is "a sequence of at least two ... non-negative integers"; the incoming check flags a leading zero or an implausible value. 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_version_format(pkg, verbose = FALSE)$passed
#> [1] TRUE