Support v3.0.0 schema sample specification

hubverse-org / hubAdmin

Utilities for administering hubverse Infectious Disease Modeling Hubs

https://hubverse-org.github.io/hubAdmin/

Other

1 stars 2 forks source link

Support v3.0.0 schema sample specification #19

Closed annakrystalli closed 3 months ago

annakrystalli commented 4 months ago

This PR will:

[x] Add back compatible dynamic validation of sample output_type_id_params in validate_confi(). Specifically, check min_ is less than os eual to and that compund_taskid set is match valid model task task IDs. Resolves #17
[x] Breaking change: Update create_output_type_sample() to handle v3.0.0 schema. In particular, create_output_type_sample() now takes arguments incompatible with previous schema versions and returns an object with an output_type_id_params object instead of output_type_id. Resolves #18
[x] Re-direct sample output type tests to latest on main branch when https://github.com/Infectious-Disease-Modeling-Hubs/schemas/pull/72 merged
[x] Test won't pass until schema released

For further details and context see here

github-actions[bot] commented 4 months ago

🚀 Deployed on https://6672872e3bf94cce5b4ac50b--hubadmin-pr-previews.netlify.app

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.92%. Comparing base (1194ab2) to head (3399d17). Report is 4 commits behind head on main.

:exclamation: Current head 3399d17 differs from pull request most recent head 9a7afa3. Consider uploading reports for the commit 9a7afa3 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #19 +/- ## ========================================== + Coverage 87.23% 87.92% +0.69% ========================================== Files 20 21 +1 Lines 1637 1830 +193 ========================================== + Hits 1428 1609 +181 - Misses 209 221 +12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

annakrystalli commented 4 months ago

Thanks! This looks good, I have made a couple of minor comments.

Additionally, I noticed that on lines 146-150 of R/create_output_type_item.R, we have the following docstring with some duplication (github didn't let me comment on this or suggest changes as part of this review because this PR didn't introduce this, but I thought maybe we could just clean it up here):
#' This can be combined with other building blocks which can then be written as
#' or appended to `tasks.json` Hub config files.
#' output type.
#' This can be combined with other building blocks which can then be written as
#' or appended to `tasks.json` Hub config files.

Thanks! Fixed this in f026d6c8e0e6943bc86152cd7d03f1bf6ae672a3