Submit Model Output

When you want to submit a model to a hub, a good first place to start is the README section in the model-output/ folder for any given hub

Important

You should contact the hubverse administrator before submitting your model to a hub. They will ask you to provide metadata for your model.

hubValidations

Useful tools are available in the hubValidations R package.

Create a submission template with hubValidations::submission_tmpl()
Validate your submission with hubValidaitons::validate_submission()

Model metadata Writing model output to a hub Validate model submission

TIP: A lightweight way to clone a hub

A modelling hub hosted on GitHub will grow in size over time and it often can take up several hundreds of megabytes or several gigabytes of space. To reduce the size of a hub on your local machine, you can use git sparse checkout. Here’s an example using the FluSight Forecast Hub, but only checking out the model outputs for the FluSight-baseline model:

git init FluSight-Forecast-Hub
cd FluSight-Forecast-Hub
git remote add origin https://github.com/cdcepi/FluSight-Forecast-Hub.git
git sparse-checkout set --no-cone '/*' 'model-output/FluSight-baseline*' '!/model-output'
git pull origin main

Now when you run git status, you will see that you only have a fraction of the files on your local machine:

git status
# On branch main
# You are in a sparse checkout with 14% of tracked files present.
#
# nothing to commit, working tree clean

important packages

As a modeler, you will find the following packages important:

hubUtils access important information about the hub
hubData seamlessly access data from a local or remote hub
hubValidations create submisson template and validate your model.