Create an R list with the config specification

createModuleConfig(
  moduleId = "about",
  tabName = "About",
  shinyModulePackage = "OhdsiShinyModules",
  moduleUiFunction = "aboutViewer",
  moduleServerFunction = "aboutServer",
  moduleDatabaseConnectionKeyService = "resultDatabaseDetails",
  moduleDatabaseConnectionKeyUsername = NULL,
  moduleInfoBoxFile = "aboutHelperFile()",
  moduleIcon = "info",
  resultDatabaseDetails,
  useKeyring = TRUE
)

Arguments

moduleId

The shiny id for the tab containing the module UI

tabName

The name of the tab in the shiny app (this will be the side menu button text)

shinyModulePackage

The R package to find the server and UI functions

moduleUiFunction

The name of the UI function in the R package shinyModulePackage

moduleServerFunction

The name of the server function in the R package shinyModulePackage

moduleDatabaseConnectionKeyService

The keyring service or the system environment variable with the result database details

moduleDatabaseConnectionKeyUsername

The keyring username or the system environment variable with the result database details

moduleInfoBoxFile

The function in the R package shinyModulePackage that contains info text

moduleIcon

The icon to use for the side menu button

resultDatabaseDetails

A list containing the result database schema (schema), the tablePrefix for the results and other optional settings

useKeyring

whether to save the resultDatabaseDetails to a keyring or system environmental variable

Value

An R list with the module config settings

Details

User specifies the settings to create a config for a module