DO NOT MERGE: Optionally return new tags_diff column formatted for html rendering

[barrettk]

Putting this on hold for now, but keeping it open because we'll likely revisit before too long

closes #404

[barrettk]

Current implementation:

log_df <- bbr::run_log("inst/model/nonmem/basic")

log_html <- log_df %>% add_tags_diff(.format = "html") %>% 
  dplyr::relocate(tags_diff) %>% select(-c(absolute_model_path, yaml_md5)) 

log_html %>% knitr::kable(escape = F) %>% kableExtra::kable_styling() 

I added some notes to the docs. Specifically I wanted to highlight that you need to add escape = FALSE to the knitr call for this to work. If using a method to render html outside of knitr/kableExtra (dont know why you would), users would have to alter this. The tilda (~~) only works for rmarkdown text, and does not render in html

For reference, here's the actual returned table:

> log_html
# A tibble: 3 × 11
  tags_diff                                run         model_type description     bbi_args     based_on tags  notes  star  tags_added tags_removed
  <chr>                                    <chr>       <chr>      <chr>           <list>       <list>   <lis> <list> <lgl> <chr>      <chr>       
1 acop tag, other tag                      1           nonmem     original acop … <named list> <NULL>   <chr> <NULL> FALSE acop tag,… ""          
2 test threads; <s>acop tag, other tag</s> 1_2_threads nonmem     NA              <named list> <chr>    <chr> <NULL> FALSE test thre… "acop tag, …
3 test threads; <s>acop tag, other tag</s> 1_4_threads nonmem     NA              <named list> <chr>    <chr> <NULL> FALSE test thre… "acop tag, …

Note that I added an additional .collapse argument. I feel like users might appreciate that functionality, without necessarily wanting the additional column

[seth127]

@kyleam @barrettk you can pause on this for a moment. I'll take a look next week. This is gonna be a pretty specialized function and I need to think through the use cases a little more. For example:

• Do we only intend it to be used in Rmd?
• Does it need to be used with knitr?
• Is there a difference based on whether we have results = 'asis' in the chunk options