mod_header_parser: Parse the header of module modules to add to the database

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

Parse the header of module modules to add to the database

Description

This is a helper function that parses the header of modules to pending addition to the shinymgr.sqlite database. This is used as a helper function by mod_register and check_mod_info to convert the data in headers into dataframes.

Usage

mod_header_parser(filePath)

Arguments

filePath

The file path to the R module script to be added.

Value

A list containing dataframes that can be used to update the shinyMgr database. These include: 1. Data for the modules table 2. Data for updating the modFunctionArguments table 3. Data for updating the modFunctionReturns table

See Also

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

Examples

# establish the path to a built-in shinymgr module
filePath <- file.path(find.package('shinymgr'), 'shinymgr/modules/poly_fit.R')

# Parse the header and return associated data as a list of dataframes.
data_to_add <- mod_header_parser(filePath)

# look at the result
str(data_to_add)

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