Diagnose a Non-Portable DESCRIPTION Encoding

Flags an Encoding outside the portable set Writing R Extensions names: UTF-8, latin1, latin2 (compared case-insensitively). An absent Encoding passes.

Usage

lab_encoding_utf8(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 non-ASCII DESCRIPTION "should contain an 'Encoding' field"; the incoming check flags a non-portable one. 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_encoding_utf8(pkg, verbose = FALSE)$passed
#> [1] TRUE