Skip to content

Metadata Checks

Lucie Contamin edited this page May 1, 2024 · 1 revision

NOTE: Validation is currently unavailable for metadata files, but participants are still asked to submit files in accordance with the checks described below.

The metadata checks are implemented to conform to the specifications specified in this file.

In addition to them, the following checks are made:

  • Metadata file must have proper yaml format.
  • The metadata file should contain all the required field: team_name, model_name, model_abbr, team_abbr, model_contributors, website_url, model_version, methods, license .
  • team_name needs to be the name of your team that is less than 50 characters, no spaces.
  • model_name and model_abbr need to be distinct from any already existing model_name.
  • model_abbr and team_abbr need to be less than 30 alphanumeric characters (_ also accepted, please avoid using other punctuation characters including -, /, etc.)
  • model_contributors must include at least one email address and written in the format specified here.
  • website_url field must be specified. This should be a valid URL or "NA" if no associated website.
  • methods is under 200 characters.
  • model_version needs to be a string
  • Optional additional accepted fields are: team_funding, data_inputs, methods_long, citation
Clone this wiki locally