access R package documentation through a {shiny} app

[kellijohnson-NOAA]

Below are some stack exchange / blog posts about how to access .Rd files from an R package in a shiny server setting. This would be useful if we used .R and resulting .Rd files to document terms instead of json files.

• https://stackoverflow.com/questions/54623129/show-r-documentation-of-a-function-in-shiny-app
• https://stackoverflow.com/questions/49210495/show-documentation-pages-in-shiny-app
• https://deanattali.com/2015/04/21/r-package-shiny-app/
• displaying a document

[ChristineStawitz-NOAA]

Thanks @kellijohnson-NOAA I think I have a very basic and ugly version of this working - you can test it by running the following in a fresh R terminal:

remotes::install_github("nmfs-fish-tools/data_dictionary", ref="shiny_a 
    pp")
library(shiny)
library(stockassessmentdictionary)
shiny_dd()

One question: You can define your own fields with the format tag, but we could also try to adhere to the existing Roxygen2 tags instead of the fields we have made up and that would put the different fields under each item at the same level of the hierarchy - any preference?

I lost steam halfway through the alphabet but feel free to edit the later .R entries if anyone has time!

[ChristineStawitz-NOAA]

• add in custom tags?
• keep every entry as a separate file
• add a family tag to filter entries
• could source related terms in the R code and then use food web r package (https://www.lewinfox.com/foodwebr/)
• @source vs @reference?