Package: formods 0.3.0

formods: 'Shiny' Modules for General Tasks

'Shiny' apps can often make use of the same key elements, this package provides modules for common tasks (data upload, wrangling data, figure generation and saving the app state), and also a framework for developing. These modules can react and interact as well as generate code to create reproducible analyses.

Authors:John Harrold [aut, cre]

formods_0.3.0.tar.gz
formods_0.3.0.zip(r-4.7)formods_0.3.0.zip(r-4.6)formods_0.3.0.zip(r-4.5)
formods_0.3.0.tgz(r-4.6-any)formods_0.3.0.tgz(r-4.5-any)
formods_0.3.0.tar.gz(r-4.7-any)formods_0.3.0.tar.gz(r-4.6-any)
formods_0.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
formods/json (API)

# Install 'formods' in R:
install.packages('formods', repos = c('https://john-harrold.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/john-harrold/formods/issues

Pkgdown/docs site:https://formods.ubiquity.tools

On CRAN:

Conda:

8.05 score 9 stars 1 packages 196 scripts 316 downloads 138 exports 106 dependencies

Last updated from:668085f14b. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK310
source / vignettesOK283
linux-release-x86_64OK406
macos-release-arm64OK320
macos-oldrel-arm64OK233
windows-develOK399
windows-releaseOK451
windows-oldrelOK393
wasm-releaseOK155

Exports:ASM_check_workflowASM_fetch_codeASM_fetch_dlfnASM_fetch_stateASM_init_stateASM_load_stateASM_mk_preloadASM_onloadASM_preloadASM_read_app_stateASM_run_workflowASM_save_stateASM_ServerASM_test_mksessionASM_test_preloadautocastDM_add_fileDM_add_urlDM_append_reportDM_del_current_elementDM_delete_sourceDM_fetch_codeDM_fetch_current_elementDM_fetch_dsDM_fetch_sourceDM_fetch_stateDM_hasdsDM_init_stateDM_mk_preloadDM_new_elementDM_onloadDM_preloadDM_run_codeDM_ServerDM_set_current_elementDM_test_mksessionDM_update_checksumDM_update_element_codeDW_add_wrangling_elementDW_append_reportDW_attach_dsdw_eval_elementDW_fetch_available_sourcesDW_fetch_codeDW_fetch_current_viewDW_fetch_dsDW_fetch_obj_ds_metaDW_fetch_stateDW_fetch_view_depsDW_hasdsDW_init_stateDW_mk_preloadDW_new_viewDW_preloadDW_rectifyDW_ServerDW_set_current_viewDW_test_mksessionDW_update_checksumdwrs_builderfers_builderfetch_holdfetch_package_versionfetch_resourceFG_append_reportFG_buildFG_extract_pageFG_fetch_codeFG_fetch_current_figFG_fetch_stateFG_init_stateFG_mk_preloadFG_new_figFG_preloadFG_ServerFG_set_current_figFG_test_mksessionFG_update_checksumFM_add_ui_tooltipFM_app_preloadFM_build_commentFM_fetch_app_codeFM_fetch_app_infoFM_fetch_app_stateFM_fetch_current_modsFM_fetch_data_formatFM_fetch_depsFM_fetch_dsFM_fetch_log_pathFM_fetch_mdlFM_fetch_mod_stateFM_fetch_user_files_pathFM_generate_reportFM_has_ds_changedFM_init_stateFM_leFM_messageFM_mk_app_preloadFM_mk_error_figFM_notifyFM_pause_screenFM_pretty_sortFM_proc_includeFM_read_yamlFM_reset_appFM_resume_screenFM_set_app_stateFM_set_mod_stateFM_set_notificationFM_set_ui_msgFM_tcformods_checkhas_changedhas_updatedicon_linkis_excelis_importableis_installedis_shinylinspacemk_preload_dirnew_module_templateremove_holdrender_strrun_formodsset_holdUD_attach_dsUD_ds_readUD_fetch_codeUD_fetch_dsUD_fetch_stateUD_init_stateUD_mk_preloadUD_preloadUD_ServerUD_test_mksessionunfactoruse_formods

Dependencies:askpassbase64encbitbit64bslibcachemcellrangerclicliprcommonmarkcpp11crayoncurldata.tabledigestdplyrevaluatefarverfastmapflextablefontawesomefontBitstreamVerafontLiberationfontquiverforcatsforeignfsgdtoolsgenericsggforceggplot2gluegtablehavenhighrhmshtmltoolshtmlwidgetshttpuvisobandjquerylibjsonliteknitrlabelinglaterlifecyclemagrittrMASSmemoisemimeofficeronbrandopensslotelpillarpkgconfigpolyclipprettyunitsprogresspromisespurrrR.methodsS3R.ooR.utilsR6raggrappdirsRColorBrewerRcppreadrreadxlrematchrhandsontableriorlangrmarkdownS7sassscalesshinyshinyAceshinyWidgetssourcetoolsstringistringrsyssystemfontstextshapingtibbletidyrtidyselecttinytextweenrtzdbutf8uuidvctrsviridisLitevroomwithrwritexlxfunxml2xtableyamlzip

Making Modules
Introduction | Current modules | formods framework | Expected functions | Expected UI components | Module interaction | Module state and reacting to changes | Helper functions in formods | Setting holds on UI elements | Dataframe formatting information | Notifications | Adding tooltips | Pausing the screen | formods state objects | App information in MM | Checklist | Configuration file | YAML configuration files
Rendered frommaking_modules.Rmdusingknitr::rmarkdown

Last update: 2026-02-08
Started: 2022-07-31

Included Modules
Introduction | Implementation | Avialable modules | Using a module | Compact UI elements | Deployment | Server functions | YAML configuration files | App State Management (ASM) | Upload Data (UD) | Data Management (DM) | Data Wrangling (DW) | Figure Generation (FG) | Known Issues | 413 Request Entity too large. | Disconnected from the server
Rendered fromincluded_modules.Rmdusingknitr::rmarkdown

Last update: 2025-03-02
Started: 2022-08-04

Workflows and Preloading Content
Introduction | Saving and loading an analysis | Creating automated workflows | Preloading the app with content
Rendered frompreload.Rmdusingknitr::rmarkdown

Last update: 2025-01-03
Started: 2024-11-28

Readme and manuals

Help Manual

Help pageTopics
Checks Workflow Preload List Against Current App StateASM_check_workflow
Fetch Module CodeASM_fetch_code
Fetch Download File NameASM_fetch_dlfn
Fetch State Manager StateASM_fetch_state
Initialize ASM Module StateASM_init_state
Load App StateASM_load_state
Make List of Current ASM StateASM_mk_preload
Updates ASM After State LoadASM_onload
Preload Data for ASM ModuleASM_preload
Read App State From Yaml FilesASM_read_app_state
Run Specified WorkflowASM_run_workflow
Write State to File for SavingASM_save_state
Save State ServerASM_Server
Populate Session Data for Module TestingASM_test_mksession
Test Specified Preload FunctionalityASM_test_preload
Automatically Cast UI Input Variableautocast
Make List of Current DM StateDM_add_file
Attaches Data Source from URLDM_add_url
Append Report ElementsDM_append_report
Deletes Current dsDM_del_current_element
Make List of Current DM StateDM_delete_source
Fetch Module CodeDM_fetch_code
Fetches Current dsDM_fetch_current_element
Fetch Data Management Module DatasetsDM_fetch_ds
Gets Source File Name for ElementDM_fetch_source
Fetch Data Management StateDM_fetch_state
Check DM State For DatasetsDM_hasds
Initialize DM Module StateDM_init_state
Make List of Current DM StateDM_mk_preload
New Data Management dsDM_new_element
Processes State After LoadingDM_onload
Preload Data for DM ModuleDM_preload
Run Element CodeDM_run_code
Data Management ServerDM_Server
Sets the Value for the Current dsDM_set_current_element
Populate Session Data for Module TestingDM_test_mksession
Updates DM Module ChecksumDM_update_checksum
Updates Element CodeDM_update_element_code
Adding Wrangling Element to Current Data ViewDW_add_wrangling_element
Append Report ElementsDW_append_report
Attach Data Set to DW ViewDW_attach_ds
Evaluates Data Wrangling Generated Codedw_eval_element
Fetch Available SourceDW_fetch_available_sources
Fetch Module CodeDW_fetch_code
Fetches Current Data ViewDW_fetch_current_view
Fetch Module DatasetsDW_fetch_ds
Fetches Metadata for a Data Source Based on R Object NameDW_fetch_obj_ds_meta
Fetch Data Wrangling StateDW_fetch_state
Recursively Finds View DependenciesDW_fetch_view_deps
Check DW State For DatasetsDW_hasds
Initialize DW Module StateDW_init_state
Make List of Current DW StateDW_mk_preload
New Data Wrangling ViewDW_new_view
Preload Data for DW ModuleDW_preload
Adding Preload List ComponentDW_proc_pll
Forces Rebuild of Current Data ViewDW_rebuild_current_view
Rebuilds Data Views After Source ChangesDW_rectify
Data Wrangling ServerDW_Server
Sets Current Data ViewDW_set_current_view
Populate Session Data for Module TestingDW_test_mksession
Updates DW Module ChecksumDW_update_checksum
Builds a Data Wrangling R Statement From ui Elements:dwrs_builder
Builds a Figure Element R Statement From UI Elements:fers_builder
Fetches the Hold Status UI Element Suppliedfetch_hold
Fetches the Current Version of Pacakgefetch_package_version
Fetches Resource Objectfetch_resource
Append Report ElementsFG_append_report
Evaluates Figure Generation CodeFG_build
Extracts Specific Page from Paginated FigureFG_extract_page
Fetch Module CodeFG_fetch_code
Fetches Current FigureFG_fetch_current_fig
Fetch Figure Generation StateFG_fetch_state
Initialize FG Module StateFG_init_state
Make List of Current FG StateFG_mk_preload
Initialize New FigureFG_new_fig
Preload Data for FG ModuleFG_preload
Figure Generation ServerFG_Server
Sets Current FigureFG_set_current_fig
Populate Session Data for Module TestingFG_test_mksession
Updates FG Module ChecksumFG_update_checksum
Add Tooltip to UI ElementFM_add_ui_tooltip
Preload Data Into AppFM_app_preload
Create RStudio Formatted CommentsFM_build_comment
Fetches the Code to Reproduce AnalysisFM_fetch_app_code
Fetches Informaiton About the AppFM_fetch_app_info
Fetches the App StateFM_fetch_app_state
Fetches Details About Current ModulesFM_fetch_current_mods
Creates Formatting Information for DatasetsFM_fetch_data_format
Fetches Dependency InformationFM_fetch_deps
Fetches Datasets from Modules in the AppFM_fetch_ds
Fetches the Path to the Log FileFM_fetch_log_path
Fetches Models from Modules in the AppFM_fetch_mdl
Fetch the Module StateFM_fetch_mod_state
Fetches the Path to the User FilesFM_fetch_user_files_path
Generate ReportFM_generate_report
Compares DS Summary with Current State for ChangesFM_has_ds_changed
Initialize a formods State ObjectFM_init_state
Adds Message to Log File and Displays it to the ConsoleFM_le
Show Message to UserFM_message
Create Preload List from AppFM_mk_app_preload
Generates `ggplot` Object with Error MessageFM_mk_error_fig
Shiny NotificationFM_notify
Starts Modal Screen PauseFM_pause_screen
Centralized Sorting FunctionFM_pretty_sort
Process Include Files in formods.yamlFM_proc_include
Fetch Yaml ContentsFM_read_yaml
Resets the App StateFM_reset_app
Stops Modal Screen PauseFM_resume_screen
Set the App StateFM_set_app_state
Set the Module StateFM_set_mod_state
Shiny NotificationFM_set_notification
Sets Message in State from UI ProcessingFM_set_ui_msg
Run Try/Catch and Process ResultsFM_tc
formods: Shiny modules for common tasks.formods-package formods
Checks `formods` Dependenciesformods_check
Depreciated: Detect if a UI element has changedhas_changed
Detect if a UI element has updatedhas_updated
Creates Icon Linkicon_link
Determines if a File is Excelis_excel
Determines if a File is Importableis_importable
Determines if a Package is Installedis_installed
Determine if Object is Shiny Session Objectis_shiny
Implementation of the 'linspace' Function from Matlablinspace
Construct Preload Directorymk_preload_dir
Makes Template Files for formods New Modulenew_module_template
Removes Hold on UI Elementremove_hold
Evaluate R Code in Stringrender_str
Run the 'formods' Shiny Apprun_formods
Sets Hold on One or All UI Elementsset_hold
Attach Data Set to UD StateUD_attach_ds
Generate Code and Load DSUD_ds_read
Fetch Module CodeUD_fetch_code
Fetch Module DatasetsUD_fetch_ds
Fetch Upload Data StateUD_fetch_state
Initialize UD Module StateUD_init_state
Make List of Current ASM StateUD_mk_preload
Preload Data for UD ModuleUD_preload
Data Upload ServerUD_Server
Populate Session Data for Module TestingUD_test_mksession
Remove Factor From Objectunfactor
Create Module Templates in a Package Repositoryuse_formods