Validate codecheck.yml metadata against ORCID

Usage

validate_codecheck_yml_orcid(
  yml_file = "codecheck.yml",
  strict = FALSE,
  validate_authors = TRUE,
  validate_codecheckers = TRUE
)

Arguments

yml_file: Path to the codecheck.yml file (defaults to "./codecheck.yml")
strict: Logical. If TRUE, throw an error on any mismatch. If FALSE (default), only issue warnings.
validate_authors: Logical. If TRUE (default), validate author ORCIDs.
validate_codecheckers: Logical. If TRUE (default), validate codechecker ORCIDs.

Value

Invisibly returns a list with validation results:

valid: Logical indicating if all checks passed
issues: Character vector of any issues found

Details

Validates author and codechecker information against the ORCID API. For each person with an ORCID, retrieves their ORCID record and compares the name in the ORCID record with the name in the local codecheck.yml file.

Author

Daniel Nuest

Examples

if (FALSE) { # \dontrun{
  # Validate with warnings only
  result <- validate_codecheck_yml_orcid()

  # Validate with strict error checking
  validate_codecheck_yml_orcid(strict = TRUE)

  # Validate only codecheckers
  validate_codecheck_yml_orcid(validate_authors = FALSE)
} # }