Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
iantaylor-NOAA opened this issue Dec 14, 2023 · 0 comments
Assignees
Labels
status --- low priority topic --- R R code type --- documentation improvements or additions to documentation

Comments

@iantaylor-NOAA
Copy link
Contributor

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:

#' @param escape As defined by [kableExtra::kable_styling()].
.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status --- low priority topic --- R R code type --- documentation improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants