This vignette provides useful technical documentation regarding the package’s internal API nomenclature as well as its technical design practices.
Functions are housed in the “R” directory and are organized into separate, distinguishable files utilizing the follwing naming procedures:
All functions should be named using an object_verb approach.
Functions are split into groups based on their usage and should fall into one of the following function groups:
utils_: General utility/helper functions not related to shiny app
app_: High-Level shiny app specific functions
app_utils_: Utility functions specific to the shiny app
mod_: App modules
alloc: fundamental functions used in the allocation process
meta_: package metadata
data_: exported datasets
dev_: internal package development functions
Note that additional ui and server prefixes/suffixes are added to filenames when a function is a combination of one of the above listings but relevant only to the user-interface or server logic of the shiny app. This helps distinguish lower-level application specific functions not directly related to a module nor relevant to both the UI and Server (i.e. app_utils_ui houses utility functions used solely in the UI such as flucol or icon_text).