R package containing functions to validate and visualize Scenario Modeling Hub submissions. For more information on the Scenario Modeling Hub and/or on how to participate, please consult the Scenario Modeling Hub GitHub repository or website.
The package is currently only available on GitHub, to install it please follow the next steps:
install.packages("remotes")
remotes::install_github("midas-network/SMHvalidation")
or it can be manually installed by directly cloning/forking/downloading the package from GitHub.
library(SMHvalidation)
The main validation function, validate_submission(), can be used to
validate Scenario Modeling Hub submissions. The function runs multiple
checks, please look at the vignette ("Validation Checks")
containing detailed information.
The function internally runs different validation checks functions from hubValidations package on SMH submissions and prints detailed information about the results of each tests on the submission.
For more information, please consult the documentation associated with the
function: ?validate_submission() for example.
To test a submission file, it's necessary to provide 2 arguments:
-
path: the path to the submission file (or folder for partitioned data) to test. PQT, PARQUET, CSV, ZIP (not partitioned), or GZ (not partitioned) file formats are accepted. The path should be relative to the path of the hub containing the file to check -
hub_path: path to the repository contains the submission files and hub config files including thetasks.jsonfile in the hubverse format (version 5.0 accepted). Please find information on thetasks.jsonformat and definition on the hubverse website
validate_submission(path, hub_path)
As a warning, the vast majority of submissions done before 2025 might return
false errors with the new format of the validate_submission() function (v1.0).
We advice to use previous version for validating those earlier submissions.
The overall project is available under an open-source MIT license.
Please feel free to open an issue if you identify any issue with the package or would like to suggest an idea/improvement. We also welcome any pull-requests.
Scenario modeling groups are supported through grants to the contributing investigators.
The Scenario Modeling Hub site is supported by the MIDAS Coordination Center, NIGMS Grants U24GM132013 (2019-2024) and R24GM153920 (2024-2029) to the University of Pittsburgh.