mod_register: Register (inserts) a new module into the shinymgr project

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

Register (inserts) a new module into the shinymgr project

Description

Insert a new record into the shinymgr.sqlite database table "modules" and accompanying tables ("modFunctionArguments", "modFunctionReturns", "modPackages")

Usage

mod_register(modName, shinyMgrPath)

Arguments

modName	Name of the new module
shinyMgrPath	Directory that holds the main shinymgr project

Details

This function reads in a module file created by mod_init and parses the header using mod_header_parser to populate the modules, modFunctionArguments, modFunctionReturns, and modPackages tables of the shinymgr.sqlite database. These tables are referenced in the app builder, so module headers must match the module functions exactly.

Value

Nothing. Records are inserted into shinymgr.sqlite.

More Info

The mod_register() 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")

References

https://code.usgs.gov/vtcfwru/shinymgr

See Also

mod_init

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

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