This function takes in authentication info for EDI and an EML file to be evaluated using the EDI congruence checker. This package returns a data frame that contains the status of the package.

evaluate_edi_package(
  user_id,
  password,
  eml_file_path,
  environment = "staging",
  package_size = "medium"
)

Arguments

user_id

EDI data portal user ID. Create an account an EDI here

password

EDI data portal user password

eml_file_path

The file path to the EML metadata document that you wish to evaluate. (A web link to the csv must be included in the dataset information in the EML in order for a data package to be evaluated.)

environment

EDI portal environment to run command in. Can be: "production" - environment for publishing to EDI , "staging" - environment to test upload and rendering of new environment, "development"

Value

This package returns a data frame that contains the status of the package. The data frame contains the following information:

  • The status of each check - Can be valid, info, warn, or error. Errors must be fixed before package can be uploaded to EDI.

  • A description of what each status is referring to

  • A suggestion of how to fix the status or improve the package.

Details

For more information about the validation services see the PASTAplus docs

Examples

if (FALSE) evaluate_edi_package(user_id = "samuelwright", 
                              eml_file_path = "data/edi20.1.xml")