Checks the formatting of ORCiDs associated with NPS emails supplied in a file

Source: R/input_validation_functions.R

Reads in a .xlsx file for data validation. Uses an NPS API to check that all the emails listed in the column author_email_list have properly formatted ORCiDs (xxxx-xxxx-xxx-xxxx) associated with them. For the Project reference type, the function will check the column leads_email_list rather than author_email_list. Lack of an ORCiD, including because the supplied email address is not a valid NPS email, is considered improperly formatted for the purposes of this test. emails supplied do not have properly formatted ORCiDs associated with them the function throws an error and lists the emails that do not have properly formatted ORCiDs associated with them. If all emails are tied to valid NPS accounts with properly formatted ORCiDs associated with them, the function passes.

check_orcid_format(
  path = getwd(),
  filename = "DSbulkUploadR_input.xlsx",
  sheet_name
)

Arguments

path

String. Path to the file. Defaults to the current working directory.

filename

String. Input file to check. Defaults to "DSbulkdUploadR_input.xlsx"

sheet_name

String. Name of the excel sheet to check.

Value

NULL (invisibly)

Examples

if (FALSE) { # \dontrun{
check_orcid_format(path = getwd(),
                   filename = "DSbulkUploadR_input.xlsx",
                   sheet_name = "AudioRecording")} # }