🚨‼️ hubUtils v0.0.1 MAJOR RELEASE 6th March 2024 - Split functionality across two new packages: hubData & hubAdmin 🚨‼️

[annakrystalli]

🚨‼️ Major Breaking Changes in upcoming Major 📦 Releases on March 6th 2024 🚨‼️

The first major release (v0.0.1) of the hubUtils package contains significant breaking changes and will be release on March 6th 2024. In addition two new packages are being introduced: hubData & hubAdmin.

Much of hubUtils has been moved and split across two smaller and more dedicated packages:

• hubData package: contains functions for connecting to, interacting with and manipulating hub data.
• hubAdmin package: contains functions for administering Hubs, in particular creating and validating hub configuration files.

hubUtils still exists but is now a lightweight package that primarily contains general utilities imported by other hubverse packages.

The philosophy behind this split is to better organise functionality thematically but also to separate and streamline dependencies for functionality required by different user groups.

Details of function migrations

• Exported functions moved to hubData: connect_hub(), connect_model_output(), expand_model_out_val_grid(), create_model_out_submit_tmpl(), coerce_to_character(), coerce_to_hub_schema() and create_hub_schema().
  • hubUtils functions re-exported to hubData: as_model_out_tbl(), validate_model_out_tbl(), model_id_split() and model_id_merge().
• Exported functions moved to hubAdmin:
  • Functions for creating config files: create_config(), create_model_task(), create_model_tasks(), create_output_type(), create_output_type_cdf(), create_output_type_mean(), create_output_type_median(), create_output_type_pmf(), create_output_type_quantile(), create_output_type_sample(), create_round(), create_rounds(), create_target_metadata(), create_target_metadata_item(), create_task_id(), create_task_ids().
  • Functions for validating config files: validate_config(),validate_model_metadata_schema(), validate_hub_config(), view_config_val_errors().
• Exported functions that remain in hubUtils: as_model_out_tbl(), validate_model_out_tbl(), check_deprecated_schema(), get_config_tid(), get_round_ids(), get_round_idx(), get_round_model_tasks(), get_round_task_id_names(), get_schema(), get_schema_url(), get_schema_valid_versions(), get_schema_version_latest(), get_task_id_names(), model_id_merge(), model_id_split(), read_config()

Actions for users

• Because hubUtils is such a foundational hubverse package, we recommend all users upgrade to the latest versions of any hubverse packages they use once v0.0.1 is released and ensure the version of hubUtils installed is 0.0.1. This includes packages like hubEnsembles and hubValidations.
• If you use any of the migrated functions in your scripts or software, please ensure you correct any deprecated hubUtils namespacing to the new package where the function now lives. For example, if you have been using hubUtils::connect_hub in your code, you will need to change it to hubData::connect_hub. To find and replace instances that need replacing project wide you can use Find in files in Rstudio or Searching across files in VS Code.
• If you are using migrated functions in your package, make sure to add the new package (e.g hubData) to your package dependencies.
• If you want to test out your functionality prior to the major release on March 6th 2024, you can install any of the packages affected from GitHub from the split-hubutils branch of the repository using split-hubutils as ref, e.g. remotes::install_github("Infectious-Disease-Modeling-Hubs/hubData", ref = "split-hubutils").
• If you want to test functionality in your package through CI prior to the major release on March 6th 2024, you can append the branch split-hubutils to the remote specification of any hubverse dependency in your DESCRIPTION file, e.g.

  Remotes:
      Infectious-Disease-Modeling-Hubs/hubData@split-hubutils`
  

Support

We are here to help with any issues related to these changes. If you have any problems or need help, please feel free to open issues in any of the packages you are having a problem with or respond to this Discussion topic.

[annakrystalli]

The hubUtils split has now gone live!

Downstream packages updated:

• hubData
• hubAdmins
• hubValidations
• hubEnsembles
• hubvis