search

hubverse-org / hubVis

Plotting methods for hub model outputs
https://hubverse-org.github.io/hubVis/
Other
3 stars 0 forks source link

Split hubutils - use v0.0.1 #29

Closed annakrystalli closed 5 months ago

annakrystalli commented 6 months ago

Add functionality split from hubUtils

Currently, the hubUtils version in a specific PR in the hubUtils repo is being specified for testing that all will work fine with updated version. Once hubUtils v0.0.1 is merged in, I'll update the DESCRIPTION to use the main hubUtils branch again.

Details of the split can be found in hubUtils NEWS.md, reproduced below:

  • First major release of hubUtils package containing significant breaking changes. Much of the package has been moved and split across two smaller and more dedicated packages:
    • hubData package: contains functions for connecting to and interacting with hub data.
    • 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().
    • hubAdmin package: contains functions for administering Hubs, in particular creating and validating hub configuration files. 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().
annakrystalli commented 6 months ago

I've tested this locally and all looks good but you may want to merge into your active branch to trigger CI on it.

LucieContamin commented 6 months ago

I wonder if I should change all my call from hubUtils::as_model_out_tbl() to hubData::as_model_out_tbl(), if we prefer to promote the usage of hubData for "interacting" with data. Does it makes sense?

annakrystalli commented 6 months ago

Because this is an import it's better to use hubUtils internally as it's a lighter packaged designed to be an import.

In vignettes and examples feel free to use hubData. Just make sure to add it to Suggests.

LucieContamin commented 6 months ago

Sounds good, thanks! I will update it!