check_mod_info: Compares mod header information to the database

In shinymgr: A Framework for Building, Managing, and Stitching 'shiny' Modules into Reproducible Workflows

Compares mod header information to the database

Description

This function checks that mod header information matches what's in the database to ensure that modules will be called and stitched correctly.

Usage

check_mod_info(modName, shinyMgrPath, verbose = TRUE)

Arguments

modName	The name of the module
shinyMgrPath	The path to the shinymgr folder.
verbose	Whether to print updates to the console (default = TRUE)

Value

A list containing dataframes of logicals indicating whether fields are consistent between the module script header and the database. These include: 1. Data for the modules table 2. Data for the modFunctionArguments table 3. Data for the modFunctionReturns table A value of TRUE indicates that the fields match, and FALSE indicates a mismatch.

More Info

The check_mod_info() function is described in the "shinymgr_modules" tutorial.

Tutorials

The shinymgr learnr tutorials include, in order:

1. learnr::run_tutorial(name = "intro", package = "shinymgr")

2. learnr::run_tutorial(name = "shiny", package = "shinymgr")

3. learnr::run_tutorial(name = "modules", package = "shinymgr")

4. learnr::run_tutorial(name = "app_modules", package = "shinymgr")

5. learnr::run_tutorial(name = "tests", package = "shinymgr")

6. learnr::run_tutorial(name = "shinymgr", package = "shinymgr")

7. learnr::run_tutorial(name = "database", package = "shinymgr")

8. learnr::run_tutorial(name = "shinymgr_modules", package = "shinymgr")

9. learnr::run_tutorial(name = "apps", package = "shinymgr")

10. learnr::run_tutorial(name = "analyses", package = "shinymgr")

11. learnr::run_tutorial(name = "reports", package = "shinymgr")

12. learnr::run_tutorial(name = "deployment", package = "shinymgr")

See Also

Other module: mod_header_parser(), mod_init(), mod_register()

Examples

# establish shinyMgrPath
parentPath <- tempdir()
shinyMgrPath <- paste0(parentPath, '/shinymgr')

# Create a demo database
shinymgr_setup(parentPath = parentPath, demo = TRUE)

#check info for different modules
check_mod_info(modName = "subset_rows", shinyMgrPath = shinyMgrPath)
  
check_mod_info(modName = "add_noise", shinyMgrPath = shinyMgrPath)
  
# Remove demo database
unlink(shinyMgrPath, recursive = TRUE)

shinymgr documentation built on May 29, 2024, 1:17 a.m.