pfmc-assessments / sa4ss

Generate a stock assessment document from Stock Synthesis output
https://pfmc-assessments.github.io/sa4ss/
Other
12 stars 7 forks source link

include text from kableExtra in arguments to table_format() (and other functions as needed) #113

Open iantaylor-NOAA opened 11 months ago

iantaylor-NOAA commented 11 months ago

Problem

Trying to figure out how to add superscripts or subscripts to tables was a pain. Eventually I happened on the need to specify escape = FALSE to sa4ss::table_format(), which allowed the use of things like $r^2$ in the column names or table content to get formatted appropriately. The help page for that function just points to the {kableExtra} function which makes it harder to track down what the arguments do: https://github.com/pfmc-assessments/sa4ss/blob/fad088132b91e90b6fc73cf775aa7c9b2c200e5e/R/table_format.R#L17.

Proposal

@kellijohnson-NOAA said that there's an easy way to automatically bring in Roxygen text from dependent packages so that the help pages within sa4ss are more informative. This is a low priority, but adding the issue now as a reminder to explore this in the future.