Learn R Programming

formods

Shiny apps can often make use of the same key elements, formods provides modules for common tasks (data upload, wrangling data, figure generation and saving the app state). These modules can react and interact as well as generate code to create reproducible analyses. {formods} also defines a framework for creating reactive modules. The vignettes outline how to use these modules as well as how to create other modules within this framework.

Installation

Copy Link

Version

Install

install.packages('formods')

Monthly Downloads

326

Version

0.2.1

License

BSD_2_clause + file LICENSE

Maintainer

John Harrold

Last Published

June 12th, 2025

Functions in formods (0.2.1)

Data Wrangling Server

DW_add_wrangling_element

Adding Wrangling Element to Current Data View

Fetch Data Wrangling State

Fetch Module Datasets

FG_append_report

Append Report Elements

Figure Generation Server

DW_fetch_current_view

Fetches Current Data View

Initialize DW Module State

Fetch Module Code

Check DW State For Datasets

Make List of Current DW State

New Data Wrangling View

Fetch Module Code

DW_test_mksession

Populate Session Data for Module Testing

DW_update_checksum

Updates DW Module Checksum

Make List of Current FG State

Fetch Figure Generation State

Initialize New Figure

FM_fetch_data_format

Creates Formatting Information for Datasets

FM_fetch_current_mods

Fetches Details About Current Modules

FM_build_comment

Create RStudio Formatted Comments

FG_fetch_current_fig

Fetches Current Figure

Initialize FG Module State

Preload Data Into App

Fetches Dependency Information

FG_set_current_fig

Sets Current Figure

FM_fetch_mod_state

Fetch the Module State

FM_fetch_app_code

Fetches the Code to Reproduce Analysis

Fetches Datasets from Modules in the App

FM_add_ui_tooltip

Add Tooltip to UI Element

FG_test_mksession

Populate Session Data for Module Testing

Preload Data for FG Module

FG_update_checksum

Updates FG Module Checksum

Centralized Sorting Function

FM_fetch_user_files_path

Fetches the Path to the User Files

Preload Data for DW Module

FM_proc_include

Sets Message in State from UI Processing

FM_set_app_state

Set the App State

Show Message to User

Adds Message to Log File and Displays it to the Console

Run Try/Catch and Process Results

FM_mk_app_preload

Preload Data Into App

Data Upload Server

Initialize a formods State Object

FM_generate_report

Generate Report

DW_set_current_view

Sets Current Data View

Shiny Notification

FM_mk_error_fig

Generates `ggplot` Object with Error Message

Attach Data Set to UD State

Generate Code and Load DS

FM_set_mod_state

Set the Module State

Evaluates Figure Generation Code

FG_extract_page

Extracts Specific Page from Paginated Figure

FM_fetch_app_info

Fetches Informaiton About the App

FM_fetch_app_state

Fetches the App State

Fetches Models from Modules in the App

FM_set_notification

Shiny Notification

Resets the App State

FM_fetch_log_path

Fetches the Path to the Log File

FM_resume_screen

Stops Modal Screen Pause

Make List of Current ASM State

Preload Data for UD Module

Determines if a Package is Installed

dw_eval_element

Evaluates Data Wrangling Generated Code

Determine if Object is Shiny Session Object

Initialize UD Module State

Fetch Upload Data State

Checks `formods` Dependencies

Builds a Data Wrangling R Statement From ui Elements:

Depreciated: Detect if a UI element has changed

fetch_package_version

Fetches the Current Version of Pacakge

formods: Shiny modules for common tasks.

Sets Message in State from UI Processing

UD_test_mksession

Populate Session Data for Module Testing

FM_pause_screen

Starts Modal Screen Pause

Automatically Cast UI Input Variable

Fetch Module Datasets

Fetch Module Code

Builds a Figure Element R Statement From UI Elements:

Detect if a UI element has updated

Fetches the Hold Status UI Element Supplied

Implementation of the linspace Function from Matlab

Sets Hold on One or All UI Elements

new_module_template

Makes Template Files for formods New Module

Run the 'formods' Shiny App

Evaluate R Code in String

Remove Factor From Object

Removes Hold on UI Element

Create Module Templates in a Package Repository

Creates Icon Link

Preload Data for ASM Module

Make List of Current ASM State

Updates ASM After State Load

Fetch Download File Name

Write State to File for Saving

ASM_fetch_state

Fetch State Manager State

Initialize ASM Module State

ASM_read_app_state

Read App State From Yaml Files

Fetch Module Code

Save State Server

Write State to File for Saving

DW_append_report

Append Report Elements

Attach Data Set to DW State

ASM_test_mksession

Populate Session Data for Module Testing