search

hubverse-org / hubUtils

Utility functions for Infectious Disease Modeling Hubs
https://hubverse-org.github.io/hubUtils/
Other
6 stars 3 forks source link

Write a 'print' method for the `model_out_tbl` class #175

Open lshandross opened 2 weeks ago

lshandross commented 2 weeks ago

Based on feedback from the Journal of Statistical Software, we think it makes sense to add a few suitable methods for the model_out_tbl class

zkamvar commented 1 week ago

Can you provide information about what is expected of the print method from the review? Looking over the usage of the model_out_tbl class, it seems like it's a wrapper around a tibble, in which case, we can update the header to read model_out_tbl: https://pillar.r-lib.org/articles/extending.html

annakrystalli commented 1 week ago

Agree with above! I was also wondering whether there was specific hubverse metadata that might be useful to also show? E.g. names and number of output_types contained? No. of models represented? Sth else?

lshandross commented 1 week ago

The JSS editors did not provide any information about what they'd like to see in the various methods they requested (print, summary, plot), so I think it's kind of up to us what we include. I like Anna's suggestion of including output types, and we could potentially include task IDs as well

annakrystalli commented 1 week ago

Maybe we could have minimum metadata in the print method but much more detail about model_out_tbl contents in the summary method?