Skip to contents

Check whether a metadata file matches the schema provided by the hub

Source: R/check_metadata_matches_schema.R
check_metadata_matches_schema.Rd

Check whether a metadata file matches the schema provided by the hub

Usage

check_metadata_matches_schema(file_path, hub_path = ".")

Arguments

file_path

character string. Path to the file being validated relative to the hub's model-metadata directory.

hub_path

Either a character string path to a local Modeling Hub directory or an object of class <SubTreeFileSystem> created using functions s3_bucket() or gs_bucket() by providing a string S3 or GCS bucket name or path to a Modeling Hub directory stored in the cloud. For more details consult the Using cloud storage (S3, GCS) in the arrow package. The hub must be fully configured with valid admin.json and tasks.json files within the hub-config directory.

Value

Depending on whether validation has succeeded, one of:

  • <message/check_success> condition class object.

  • <error/check_failure> condition class object.

Returned object also inherits from subclass <hub_check>.