# 'Shiny' Modules for General Tasks

## Documentation for package ‘formods’ version 0.2.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A D F H I L N R S U

formods-package | formods: Shiny modules for common tasks.

## -- A --

ASM_fetch_code | Fetch Module Code
ASM_fetch_dlfn | Fetch Download File Name
ASM_fetch_state | Fetch State Manager State
ASM_init_state | Initialize ASM Module State
ASM_load_state | Write State to File for Saving
ASM_mk_preload | Make List of Current ASM State
ASM_onload | Updates ASM After State Load
ASM_preload | Preload Data for ASM Module
ASM_read_app_state | Read App State From Yaml Files
ASM_save_state | Write State to File for Saving
ASM_Server | Save State Server
ASM_test_mksession | Populate Session Data for Module Testing
autocast | Automatically Cast UI Input Variable

## -- D --

dwrs_builder | Builds a Data Wrangling R Statement From ui Elements:
DW_add_wrangling_element | Adding Wrangling Element to Current Data View
DW_append_report | Append Report Elements
DW_attach_ds | Attach Data Set to DW State
dw_eval_element | Evaluates Data Wrangling Generated Code
DW_fetch_code | Fetch Module Code
DW_fetch_current_view | Fetches Current Data View
DW_fetch_ds | Fetch Module Datasets
DW_fetch_state | Fetch Data Wrangling State
DW_hasds | Check DW State For Datasets
DW_init_state | Initialize DW Module State
DW_mk_preload | Make List of Current DW State
DW_new_view | New Data Wrangling View
DW_preload | Preload Data for DW Module
DW_Server | Data Wrangling Server
DW_set_current_view | Sets Current Data View
DW_test_mksession | Populate Session Data for Module Testing
DW_update_checksum | Updates DW Module Checksum

## -- F --

fers_builder | Builds a Figure Element R Statement From UI Elements:
fetch_hold | Fetches the Hold Status UI Element Supplied
fetch_package_version | Fetches the Current Version of Pacakge
FG_append_report | Append Report Elements
FG_build | Evaluates Figure Generation Code
FG_extract_page | Extracts Specific Page from Paginated Figure
FG_fetch_code | Fetch Module Code
FG_fetch_current_fig | Fetches Current Figure
FG_fetch_state | Fetch Figure Generation State
FG_init_state | Initialize FG Module State
FG_mk_preload | Make List of Current FG State
FG_new_fig | Initialize New Figure
FG_preload | Preload Data for FG Module
FG_Server | Figure Generation Server
FG_set_current_fig | Sets Current Figure
FG_test_mksession | Populate Session Data for Module Testing
FG_update_checksum | Updates FG Module Checksum
FM_add_ui_tooltip | Add Tooltip to UI Element
FM_app_preload | Preload Data Into App
FM_build_comment | Create RStudio Formatted Comments
FM_fetch_app_code | Fetches the Code to Reproduce Analysis
FM_fetch_app_info | Fetches Informaiton About the App
FM_fetch_app_state | Fetches the App State
FM_fetch_current_mods | Fetches Details About Current Modules
FM_fetch_data_format | Creates Formatting Information for Datasets
FM_fetch_deps | Fetches Dependency Information
FM_fetch_ds | Fetches Datasets from Modules in the App
FM_fetch_log_path | Fetches the Path to the Log File
FM_fetch_mdl | Fetches Models from Modules in the App
FM_fetch_mod_state | Fetch the Module State
FM_fetch_user_files_path | Fetches the Path to the User Files
FM_generate_report | Generate Report
FM_init_state | Initialize a formods State Object
FM_le | Adds Message to Log File and Displays it to the Console
FM_message | Show Message to User
FM_mk_app_preload | Preload Data Into App
FM_mk_error_fig | Generates 'ggplot' Object with Error Message
FM_notify | Shiny Notification
FM_pause_screen | Starts Modal Screen Pause
FM_pretty_sort | Centralized Sorting Function
FM_proc_include | Sets Message in State from UI Processing
FM_reset_app | Resets the App State
FM_resume_screen | Stops Modal Screen Pause
FM_set_app_state | Set the App State
FM_set_mod_state | Set the Module State
FM_set_notification | Shiny Notification
FM_set_ui_msg | Sets Message in State from UI Processing
FM_tc | Run Try/Catch and Process Results
formods | formods: Shiny modules for common tasks.
formods_check | Checks 'formods' Dependencies

## -- H --

has_changed | Depreciated: Detect if a UI element has changed
has_updated | Detect if a UI element has updated

## -- I --

icon_link | Creates Icon Link
is_installed | Determines if a Package is Installed
is_shiny | Determine if Object is Shiny Session Object

## -- L --

linspace | Implementation of the 'linspace' Function from Matlab

## -- N --

new_module_template | Makes Template Files for formods New Module

## -- R --

remove_hold | Removes Hold on UI Element
render_str | Evaluate R Code in String
run_formods | Run the 'formods' Shiny App

## -- S --

set_hold | Sets Hold on One or All UI Elements

## -- U --

UD_attach_ds | Attach Data Set to UD State
UD_ds_read | Generate Code and Load DS
UD_fetch_code | Fetch Module Code
UD_fetch_ds | Fetch Module Datasets
UD_fetch_state | Fetch Upload Data State
UD_init_state | Initialize UD Module State
UD_mk_preload | Make List of Current ASM State
UD_preload | Preload Data for UD Module
UD_Server | Data Upload Server
UD_test_mksession | Populate Session Data for Module Testing
unfactor | Remove Factor From Object
use_formods | Create Module Templates in a Package Repository