diff --git a/NAMESPACE b/NAMESPACE
index d8b1544..cdb6240 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -48,6 +48,7 @@ export(FM_fetch_user_files_path)
export(FM_generate_report)
export(FM_init_state)
export(FM_le)
+export(FM_message)
export(FM_mk_error_fig)
export(FM_notify)
export(FM_pause_screen)
diff --git a/R/formods.R b/R/formods.R
index 7cdc8f1..a27eaeb 100644
--- a/R/formods.R
+++ b/R/formods.R
@@ -600,34 +600,37 @@ FM_le = function(state, entry, escape_braces=TRUE, entry_type="alert"){
# Writing messages to the console
if(state[["yaml"]][["FM"]][["logging"]][["console"]]){
for(line in entry){
+ FM_message(line=line,
+ escape_braces=escape_braces,
+ entry_type=entry_type)
# This will conditionally show the entry if the cli packages is present:
- if(system.file(package="cli") != ""){
- if(escape_braces){
- if(entry_type=="alert"){
- cli::cli_alert("{line}") }
- if(entry_type=="danger"){
- cli::cli_alert_danger("{line}") }
- if(entry_type=="warning"){
- cli::cli_alert_warning("{line}") }
- if(entry_type=="info"){
- cli::cli_alert_info("{line}") }
- if(entry_type=="success"){
- cli::cli_alert_success("{line}") }
- } else {
- if(entry_type=="alert"){
- cli::cli_alert(line)}
- if(entry_type=="danger"){
- cli::cli_alert_danger(line)}
- if(entry_type=="warning"){
- cli::cli_alert_warning(line)}
- if(entry_type=="info"){
- cli::cli_alert_info(line)}
- if(entry_type=="success"){
- cli::cli_alert_success(line)}
- }
- } else {
- message(line)
- }
+ #if(system.file(package="cli") != ""){
+ # if(escape_braces){
+ # if(entry_type=="alert"){
+ # cli::cli_alert("{line}") }
+ # if(entry_type=="danger"){
+ # cli::cli_alert_danger("{line}") }
+ # if(entry_type=="warning"){
+ # cli::cli_alert_warning("{line}") }
+ # if(entry_type=="info"){
+ # cli::cli_alert_info("{line}") }
+ # if(entry_type=="success"){
+ # cli::cli_alert_success("{line}") }
+ # } else {
+ # if(entry_type=="alert"){
+ # cli::cli_alert(line)}
+ # if(entry_type=="danger"){
+ # cli::cli_alert_danger(line)}
+ # if(entry_type=="warning"){
+ # cli::cli_alert_warning(line)}
+ # if(entry_type=="info"){
+ # cli::cli_alert_info(line)}
+ # if(entry_type=="success"){
+ # cli::cli_alert_success(line)}
+ # }
+ #} else {
+ # message(line)
+ #}
}
}
@@ -644,7 +647,49 @@ FM_le = function(state, entry, escape_braces=TRUE, entry_type="alert"){
isgood}
-
+#'@export
+#'@title Show Message to User
+#'@description Writes a message to the console depending on whether cli is
+#'installed or not.
+#'@param line Text to display
+#'@param escape_braces Set to \code{TRUE} (default) to escape curly braces in the entry, set to \code{FALSE} to have the values interpreted.
+#'@param entry_type Set to either "alert"(default), "danger", "info", "success", or "warning"
+#'@return Returns NULL
+#'@examples
+#' mr = FM_message("This is a normal message")
+#' mr = FM_message("This is a danger message", entry_type="danger")
+#' mr = FM_message("This is a info message", entry_type="info")
+#' mr = FM_message("This is a success message", entry_type="success")
+#' mr = FM_message("This is a warning message", entry_type="warning")
+FM_message = function(line, escape_braces=TRUE, entry_type="alert"){
+ if(system.file(package="cli") != ""){
+ if(escape_braces){
+ if(entry_type=="alert"){
+ cli::cli_alert("{line}") }
+ if(entry_type=="danger"){
+ cli::cli_alert_danger("{line}") }
+ if(entry_type=="warning"){
+ cli::cli_alert_warning("{line}") }
+ if(entry_type=="info"){
+ cli::cli_alert_info("{line}") }
+ if(entry_type=="success"){
+ cli::cli_alert_success("{line}") }
+ } else {
+ if(entry_type=="alert"){
+ cli::cli_alert(line)}
+ if(entry_type=="danger"){
+ cli::cli_alert_danger(line)}
+ if(entry_type=="warning"){
+ cli::cli_alert_warning(line)}
+ if(entry_type=="info"){
+ cli::cli_alert_info(line)}
+ if(entry_type=="success"){
+ cli::cli_alert_success(line)}
+ }
+ } else {
+ message(line)
+ }
+NULL}
#'@export
#'@title Run Try/Catch and Process Results
@@ -864,13 +909,15 @@ FM_set_app_state <- function(session, app_state, set_holds = TRUE){
}
}
} else {
- if(system.file(package="cli") != ""){
- cli::cli_alert("FM_set_app_state()")
- cli::cli_alert("Unable to find ASM state.")
- } else {
- message("FM_set_app_state()")
- message("Unable to find ASM state.")
- }
+ FM_message(line="FM_set_app_state()")
+ FM_message(line="Unable to find ASM state.")
+ #if(system.file(package="cli") != ""){
+ # cli::cli_alert("FM_set_app_state()")
+ # cli::cli_alert("Unable to find ASM state.")
+ #} else {
+ # message("FM_set_app_state()")
+ # message("Unable to find ASM state.")
+ #}
}
diff --git a/docs/articles/included_modules.html b/docs/articles/included_modules.html
index 1e2da32..bf498ae 100644
--- a/docs/articles/included_modules.html
+++ b/docs/articles/included_modules.html
@@ -131,38 +131,38 @@ <h2 id="avialable-modules">Avialable modules<a class="anchor" aria-label="anchor
column contains the short name used to identify that module. The
individual HTML UI elements are listed as well as other UI outputs.</p>
<div class="tabwid">
-<style>.cl-19793584{}.cl-1974d430{font-family:'Helvetica';font-size:11pt;font-weight:bold;font-style:normal;text-decoration:none;color:rgba(0, 0, 0, 1.00);background-color:transparent;}.cl-1974d46c{font-family:'Helvetica';font-size:11pt;font-weight:normal;font-style:normal;text-decoration:none;color:rgba(0, 0, 0, 1.00);background-color:transparent;}.cl-197726b8{margin:0;text-align:left;border-bottom: 0 solid rgba(0, 0, 0, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);padding-bottom:5pt;padding-top:5pt;padding-left:5pt;padding-right:5pt;line-height: 1;background-color:transparent;}.cl-197726b9{margin:0;text-align:left;border-bottom: 0 solid rgba(0, 0, 0, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);padding-bottom:5pt;padding-top:5pt;padding-left:5pt;padding-right:5pt;line-height: 1;background-color:transparent;}.cl-1977304a{width:1.805in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-1977304b{width:0.616in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773054{width:15.505in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773055{width:4.566in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773056{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773057{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773058{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-1977305e{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-1977305f{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773060{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773061{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773062{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773068{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773069{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-1977306a{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-1977306b{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-1977306c{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773072{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773073{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-19773074{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}</style>
-<table data-quarto-disable-processing="true" class="table cl-19793584">
+<style>.cl-bf26aaa8{}.cl-bf220caa{font-family:'Helvetica';font-size:11pt;font-weight:bold;font-style:normal;text-decoration:none;color:rgba(0, 0, 0, 1.00);background-color:transparent;}.cl-bf220cbe{font-family:'Helvetica';font-size:11pt;font-weight:normal;font-style:normal;text-decoration:none;color:rgba(0, 0, 0, 1.00);background-color:transparent;}.cl-bf248250{margin:0;text-align:left;border-bottom: 0 solid rgba(0, 0, 0, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);padding-bottom:5pt;padding-top:5pt;padding-left:5pt;padding-right:5pt;line-height: 1;background-color:transparent;}.cl-bf24825a{margin:0;text-align:left;border-bottom: 0 solid rgba(0, 0, 0, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);padding-bottom:5pt;padding-top:5pt;padding-left:5pt;padding-right:5pt;line-height: 1;background-color:transparent;}.cl-bf248de0{width:1.805in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248de1{width:0.616in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248dea{width:15.505in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248deb{width:4.566in;background-color:transparent;vertical-align: middle;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 1.5pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248dec{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248df4{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248df5{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248df6{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0 solid rgba(0, 0, 0, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248dfe{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248dff{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e00{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e01{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e08{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e09{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e0a{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e0b{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 0.75pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e0c{width:1.805in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e12{width:0.616in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e13{width:15.505in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}.cl-bf248e14{width:4.566in;background-color:transparent;vertical-align: top;border-bottom: 1.5pt solid rgba(102, 102, 102, 1.00);border-top: 0.75pt solid rgba(102, 102, 102, 1.00);border-left: 0 solid rgba(0, 0, 0, 1.00);border-right: 0 solid rgba(0, 0, 0, 1.00);margin-bottom:0;margin-top:0;margin-left:0;margin-right:0;}</style>
+<table data-quarto-disable-processing="true" class="table cl-bf26aaa8">
<thead><tr style="overflow-wrap:break-word;">
-<th class="cl-1977304a"><p class="cl-197726b8"><span class="cl-1974d430">Module</span></p></th>
-<th class="cl-1977304b"><p class="cl-197726b8"><span class="cl-1974d430">SN</span></p></th>
-<th class="cl-19773054"><p class="cl-197726b8"><span class="cl-1974d430">htmlOutput</span></p></th>
-<th class="cl-19773055"><p class="cl-197726b8"><span class="cl-1974d430">Other Outputs</span></p></th>
+<th class="cl-bf248de0"><p class="cl-bf248250"><span class="cl-bf220caa">Module</span></p></th>
+<th class="cl-bf248de1"><p class="cl-bf248250"><span class="cl-bf220caa">SN</span></p></th>
+<th class="cl-bf248dea"><p class="cl-bf248250"><span class="cl-bf220caa">htmlOutput</span></p></th>
+<th class="cl-bf248deb"><p class="cl-bf248250"><span class="cl-bf220caa">Other Outputs</span></p></th>
</tr></thead>
<tbody>
<tr style="overflow-wrap:break-word;">
-<td class="cl-19773056"><p class="cl-197726b9"><span class="cl-1974d46c">App State Mangement</span></p></td>
-<td class="cl-19773057"><p class="cl-197726b9"><span class="cl-1974d46c">ASM</span></p></td>
-<td class="cl-19773058"><p class="cl-197726b9"><span class="cl-1974d46c">ui_asm_save_name, ui_asm_save_button, ui_asm_load_state</span></p></td>
-<td class="cl-1977305e"><p class="cl-197726b9"><span class="cl-1974d46c">ui_asm_msg, ui_asm_ace_code</span></p></td>
+<td class="cl-bf248dec"><p class="cl-bf24825a"><span class="cl-bf220cbe">App State Mangement</span></p></td>
+<td class="cl-bf248df4"><p class="cl-bf24825a"><span class="cl-bf220cbe">ASM</span></p></td>
+<td class="cl-bf248df5"><p class="cl-bf24825a"><span class="cl-bf220cbe">ui_asm_save_name, ui_asm_save_button, ui_asm_load_state</span></p></td>
+<td class="cl-bf248df6"><p class="cl-bf24825a"><span class="cl-bf220cbe">ui_asm_msg, ui_asm_ace_code</span></p></td>
</tr>
<tr style="overflow-wrap:break-word;">
-<td class="cl-1977305f"><p class="cl-197726b9"><span class="cl-1974d46c">Upload Data</span></p></td>
-<td class="cl-19773060"><p class="cl-197726b9"><span class="cl-1974d46c">UD</span></p></td>
-<td class="cl-19773061"><p class="cl-197726b9"><span class="cl-1974d46c">ui_ud_load_data, ui_ud_select_sheets, ui_ud_text_load_result, ui_ud_data_preview</span></p></td>
-<td class="cl-19773062"><p class="cl-197726b9"><span class="cl-1974d46c">ui_ud_ace_code</span></p></td>
+<td class="cl-bf248dfe"><p class="cl-bf24825a"><span class="cl-bf220cbe">Upload Data</span></p></td>
+<td class="cl-bf248dff"><p class="cl-bf24825a"><span class="cl-bf220cbe">UD</span></p></td>
+<td class="cl-bf248e00"><p class="cl-bf24825a"><span class="cl-bf220cbe">ui_ud_load_data, ui_ud_select_sheets, ui_ud_text_load_result, ui_ud_data_preview</span></p></td>
+<td class="cl-bf248e01"><p class="cl-bf24825a"><span class="cl-bf220cbe">ui_ud_ace_code</span></p></td>
</tr>
<tr style="overflow-wrap:break-word;">
-<td class="cl-19773068"><p class="cl-197726b9"><span class="cl-1974d46c">Data Wrangling</span></p></td>
-<td class="cl-19773069"><p class="cl-197726b9"><span class="cl-1974d46c">DW</span></p></td>
-<td class="cl-1977306a"><p class="cl-197726b9"><span class="cl-1974d46c">ui_dw_views, ui_dw_key, ui_dw_new_view, ui_dw_save_view, ui_dw_del_view, ui_dw_copy_view, ui_dw_add_element_button, ui_dw_select, ui_dw_new_element_row</span></p></td>
-<td class="cl-1977306b"><p class="cl-197726b9"><span class="cl-1974d46c">hot_dw_elements, hot_data_preview, ui_dw_msg, ui_dw_code</span></p></td>
+<td class="cl-bf248e08"><p class="cl-bf24825a"><span class="cl-bf220cbe">Data Wrangling</span></p></td>
+<td class="cl-bf248e09"><p class="cl-bf24825a"><span class="cl-bf220cbe">DW</span></p></td>
+<td class="cl-bf248e0a"><p class="cl-bf24825a"><span class="cl-bf220cbe">ui_dw_views, ui_dw_key, ui_dw_new_view, ui_dw_save_view, ui_dw_del_view, ui_dw_copy_view, ui_dw_add_element_button, ui_dw_select, ui_dw_new_element_row</span></p></td>
+<td class="cl-bf248e0b"><p class="cl-bf24825a"><span class="cl-bf220cbe">hot_dw_elements, hot_data_preview, ui_dw_msg, ui_dw_code</span></p></td>
</tr>
<tr style="overflow-wrap:break-word;">
-<td class="cl-1977306c"><p class="cl-197726b9"><span class="cl-1974d46c">Figure Generation</span></p></td>
-<td class="cl-19773072"><p class="cl-197726b9"><span class="cl-1974d46c">FG</span></p></td>
-<td class="cl-19773073"><p class="cl-197726b9"><span class="cl-1974d46c">ui_fg_curr_views, ui_fg_curr_figs, ui_fg_new_fig, ui_fg_save_fig, ui_fg_del_fig, ui_fg_copy_fig, ui_fg_fig_name, ui_fg_fig_notes, ui_fg_add_element_button, ui_fg_select, ui_fg_new_element_row, ui_fg_msg, ui_fg_slider_page</span></p></td>
-<td class="cl-19773074"><p class="cl-197726b9"><span class="cl-1974d46c">hot_fg_elements, ui_fg_preview_ggplot, ui_fg_msg, ui_fg_code</span></p></td>
+<td class="cl-bf248e0c"><p class="cl-bf24825a"><span class="cl-bf220cbe">Figure Generation</span></p></td>
+<td class="cl-bf248e12"><p class="cl-bf24825a"><span class="cl-bf220cbe">FG</span></p></td>
+<td class="cl-bf248e13"><p class="cl-bf24825a"><span class="cl-bf220cbe">ui_fg_curr_views, ui_fg_curr_figs, ui_fg_new_fig, ui_fg_save_fig, ui_fg_del_fig, ui_fg_copy_fig, ui_fg_fig_name, ui_fg_fig_notes, ui_fg_add_element_button, ui_fg_select, ui_fg_new_element_row, ui_fg_msg, ui_fg_slider_page</span></p></td>
+<td class="cl-bf248e14"><p class="cl-bf24825a"><span class="cl-bf220cbe">hot_fg_elements, ui_fg_preview_ggplot, ui_fg_msg, ui_fg_code</span></p></td>
</tr>
</tbody>
</table>
diff --git a/docs/articles/making_modules.html b/docs/articles/making_modules.html
index df4df3f..52bce68 100644
--- a/docs/articles/making_modules.html
+++ b/docs/articles/making_modules.html
@@ -492,8 +492,8 @@ <h3 id="dataframe-formatting-information">Dataframe formatting information<a cla
<span> colHeaders <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/vector.html" class="external-link">as.vector</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/unlist.html" class="external-link">unlist</a></span><span class="op">(</span><span class="va">hfmt</span><span class="op">[[</span><span class="st">"col_heads"</span><span class="op">]</span><span class="op">]</span><span class="op">)</span><span class="op">)</span>,</span>
<span> rowHeaders <span class="op">=</span> <span class="cn">NULL</span></span>
<span> <span class="op">)</span></span></code></pre></div>
-<div id="htmlwidget-fb562c883680eb17514e" style="width:100%;height:100%;" class="rhandsontable html-widget "></div>
-<script type="application/json" data-for="htmlwidget-fb562c883680eb17514e">{"x":{"data":[{"ID":1,"TIME_DY":0,"TIME_HR":0,"NTIME_DY":0,"NTIME_HR":0,"TIME":0,"AMT":3000000,"DV":0,"RECDESC":"dose","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"Ac","DUR":0,"EVID":1,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":0,"TIME_HR":0,"NTIME_DY":0,"NTIME_HR":0,"TIME":0,"AMT":0,"DV":1250,"RECDESC":"BM_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"BM_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":0,"TIME_HR":0,"NTIME_DY":0,"NTIME_HR":0,"TIME":0,"AMT":0,"DV":0,"RECDESC":"C_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"C_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":1,"TIME_HR":24,"NTIME_DY":1,"NTIME_HR":24,"TIME":24,"AMT":0,"DV":1647,"RECDESC":"BM_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"BM_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":1,"TIME_HR":24,"NTIME_DY":1,"NTIME_HR":24,"TIME":24,"AMT":0,"DV":690.5,"RECDESC":"C_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"C_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":2,"TIME_HR":48,"NTIME_DY":2,"NTIME_HR":48,"TIME":48,"AMT":0,"DV":1947,"RECDESC":"BM_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"BM_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1}],"rClass":["tbl_df","tbl","data.frame"],"rColClasses":{"ID":"numeric","TIME_DY":"numeric","TIME_HR":"numeric","NTIME_DY":"numeric","NTIME_HR":"numeric","TIME":"numeric","AMT":"numeric","DV":"numeric","RECDESC":"character","DOSE":"numeric","DOSE_STR":"character","Cohort":"character","ROUTE":"character","WT":"numeric","SUBTYPE":"character","SEX":"character","F1":"numeric","ka":"numeric","CL":"numeric","Vc":"numeric","Vp":"numeric","Q":"numeric","BM_IC":"numeric","kdeg_BM":"numeric","Emax":"numeric","EC50":"numeric","CMT":"character","DUR":"numeric","EVID":"numeric","NDose":"character","DOSE_NUM":"numeric","SUBTYPE_ID":"numeric","SEX_ID":"numeric"},"rColnames":["ID","TIME_DY","TIME_HR","NTIME_DY","NTIME_HR","TIME","AMT","DV","RECDESC","DOSE","DOSE_STR","Cohort","ROUTE","WT","SUBTYPE","SEX","F1","ka","CL","Vc","Vp","Q","BM_IC","kdeg_BM","Emax","EC50","CMT","DUR","EVID","NDose","DOSE_NUM","SUBTYPE_ID","SEX_ID"],"rColHeaders":["ID","TIME_DY","TIME_HR","NTIME_DY","NTIME_HR","TIME","AMT","DV","RECDESC","DOSE","DOSE_STR","Cohort","ROUTE","WT","SUBTYPE","SEX","F1","ka","CL","Vc","Vp","Q","BM_IC","kdeg_BM","Emax","EC50","CMT","DUR","EVID","NDose","DOSE_NUM","SUBTYPE_ID","SEX_ID"],"rRowHeaders":null,"rDataDim":[6,33],"selectCallback":false,"colHeaders":["<span style='color:#3C8DBC'><b>ID<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>TIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>TIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>NTIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>NTIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>TIME<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>AMT<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>DV<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>RECDESC<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>DOSE<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>DOSE_STR<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#DD4B39'><b>Cohort<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#DD4B39'><b>ROUTE<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>WT<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>SUBTYPE<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#DD4B39'><b>SEX<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>F1<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>ka<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>CL<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Vc<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Vp<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Q<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>BM_IC<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>kdeg_BM<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Emax<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>EC50<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>CMT<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>DUR<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>EVID<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>NDose<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>DOSE_NUM<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>SUBTYPE_ID<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>SEX_ID<\/b><br/><font size='-3'>num<\/font><\/span>"],"rowHeaders":null,"columns":[{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null}],"width":"100%","height":"100%","debug":0,"search":false,"stretchH":"none","comments":false,"contextMenu":{"items":{"row_above":[],"row_below":[],"remove_row":[],"hsep3":{"name":"---------"},"undo":[],"redo":[],"hsep4":{"name":"---------"},"alignment":[]}}},"evals":["columns.0.renderer","columns.1.renderer","columns.2.renderer","columns.3.renderer","columns.4.renderer","columns.5.renderer","columns.6.renderer","columns.7.renderer","columns.8.renderer","columns.9.renderer","columns.10.renderer","columns.11.renderer","columns.12.renderer","columns.13.renderer","columns.14.renderer","columns.15.renderer","columns.16.renderer","columns.17.renderer","columns.18.renderer","columns.19.renderer","columns.20.renderer","columns.21.renderer","columns.22.renderer","columns.23.renderer","columns.24.renderer","columns.25.renderer","columns.26.renderer","columns.27.renderer","columns.28.renderer","columns.29.renderer","columns.30.renderer","columns.31.renderer","columns.32.renderer"],"jsHooks":[]}</script><p>To add subtext to a selection widget in Shiny you need to use the
+<div id="htmlwidget-9a7a10af09eefabe4024" style="width:100%;height:100%;" class="rhandsontable html-widget "></div>
+<script type="application/json" data-for="htmlwidget-9a7a10af09eefabe4024">{"x":{"data":[{"ID":1,"TIME_DY":0,"TIME_HR":0,"NTIME_DY":0,"NTIME_HR":0,"TIME":0,"AMT":3000000,"DV":0,"RECDESC":"dose","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"Ac","DUR":0,"EVID":1,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":0,"TIME_HR":0,"NTIME_DY":0,"NTIME_HR":0,"TIME":0,"AMT":0,"DV":1250,"RECDESC":"BM_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"BM_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":0,"TIME_HR":0,"NTIME_DY":0,"NTIME_HR":0,"TIME":0,"AMT":0,"DV":0,"RECDESC":"C_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"C_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":1,"TIME_HR":24,"NTIME_DY":1,"NTIME_HR":24,"TIME":24,"AMT":0,"DV":1647,"RECDESC":"BM_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"BM_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":1,"TIME_HR":24,"NTIME_DY":1,"NTIME_HR":24,"TIME":24,"AMT":0,"DV":690.5,"RECDESC":"C_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"C_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1},{"ID":1,"TIME_DY":2,"TIME_HR":48,"NTIME_DY":2,"NTIME_HR":48,"TIME":48,"AMT":0,"DV":1947,"RECDESC":"BM_ng_ml","DOSE":3000000,"DOSE_STR":"3 mg","Cohort":"SD 3 mg IV","ROUTE":"IV","WT":67.9,"SUBTYPE":"PT","SEX":"Female","F1":0.744,"ka":0.449,"CL":0.25,"Vc":3.67,"Vp":3.77,"Q":0.325,"BM_IC":1250,"kdeg_BM":0.1,"Emax":190,"EC50":300,"CMT":"BM_ng_ml","DUR":0,"EVID":0,"NDose":"SD","DOSE_NUM":1,"SUBTYPE_ID":1,"SEX_ID":1}],"rClass":["tbl_df","tbl","data.frame"],"rColClasses":{"ID":"numeric","TIME_DY":"numeric","TIME_HR":"numeric","NTIME_DY":"numeric","NTIME_HR":"numeric","TIME":"numeric","AMT":"numeric","DV":"numeric","RECDESC":"character","DOSE":"numeric","DOSE_STR":"character","Cohort":"character","ROUTE":"character","WT":"numeric","SUBTYPE":"character","SEX":"character","F1":"numeric","ka":"numeric","CL":"numeric","Vc":"numeric","Vp":"numeric","Q":"numeric","BM_IC":"numeric","kdeg_BM":"numeric","Emax":"numeric","EC50":"numeric","CMT":"character","DUR":"numeric","EVID":"numeric","NDose":"character","DOSE_NUM":"numeric","SUBTYPE_ID":"numeric","SEX_ID":"numeric"},"rColnames":["ID","TIME_DY","TIME_HR","NTIME_DY","NTIME_HR","TIME","AMT","DV","RECDESC","DOSE","DOSE_STR","Cohort","ROUTE","WT","SUBTYPE","SEX","F1","ka","CL","Vc","Vp","Q","BM_IC","kdeg_BM","Emax","EC50","CMT","DUR","EVID","NDose","DOSE_NUM","SUBTYPE_ID","SEX_ID"],"rColHeaders":["ID","TIME_DY","TIME_HR","NTIME_DY","NTIME_HR","TIME","AMT","DV","RECDESC","DOSE","DOSE_STR","Cohort","ROUTE","WT","SUBTYPE","SEX","F1","ka","CL","Vc","Vp","Q","BM_IC","kdeg_BM","Emax","EC50","CMT","DUR","EVID","NDose","DOSE_NUM","SUBTYPE_ID","SEX_ID"],"rRowHeaders":null,"rDataDim":[6,33],"selectCallback":false,"colHeaders":["<span style='color:#3C8DBC'><b>ID<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>TIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>TIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>NTIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>NTIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>TIME<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>AMT<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>DV<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>RECDESC<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>DOSE<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>DOSE_STR<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#DD4B39'><b>Cohort<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#DD4B39'><b>ROUTE<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>WT<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>SUBTYPE<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#DD4B39'><b>SEX<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>F1<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>ka<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>CL<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Vc<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Vp<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Q<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>BM_IC<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>kdeg_BM<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>Emax<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>EC50<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>CMT<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>DUR<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>EVID<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#DD4B39'><b>NDose<\/b><br/><font size='-3'>text<\/font><\/span>","<span style='color:#3C8DBC'><b>DOSE_NUM<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>SUBTYPE_ID<\/b><br/><font size='-3'>num<\/font><\/span>","<span style='color:#3C8DBC'><b>SEX_ID<\/b><br/><font size='-3'>num<\/font><\/span>"],"rowHeaders":null,"columns":[{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"text","renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null},{"type":"numeric","numericFormat":{"pattern":"0.00"},"renderer":"customRenderer","default":null}],"width":"100%","height":"100%","debug":0,"search":false,"stretchH":"none","comments":false,"contextMenu":{"items":{"row_above":[],"row_below":[],"remove_row":[],"hsep3":{"name":"---------"},"undo":[],"redo":[],"hsep4":{"name":"---------"},"alignment":[]}}},"evals":["columns.0.renderer","columns.1.renderer","columns.2.renderer","columns.3.renderer","columns.4.renderer","columns.5.renderer","columns.6.renderer","columns.7.renderer","columns.8.renderer","columns.9.renderer","columns.10.renderer","columns.11.renderer","columns.12.renderer","columns.13.renderer","columns.14.renderer","columns.15.renderer","columns.16.renderer","columns.17.renderer","columns.18.renderer","columns.19.renderer","columns.20.renderer","columns.21.renderer","columns.22.renderer","columns.23.renderer","columns.24.renderer","columns.25.renderer","columns.26.renderer","columns.27.renderer","columns.28.renderer","columns.29.renderer","columns.30.renderer","columns.31.renderer","columns.32.renderer"],"jsHooks":[]}</script><p>To add subtext to a selection widget in Shiny you need to use the
<a href="https://github.com/dreamRs/shinyWidgets" class="external-link">shinyWidgets</a> package.</p>
<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="va">sel_subtext</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/vector.html" class="external-link">as.vector</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/unlist.html" class="external-link">unlist</a></span><span class="op">(</span> <span class="va">hfmt</span><span class="op">[[</span><span class="st">"col_subtext"</span><span class="op">]</span><span class="op">]</span><span class="op">)</span><span class="op">)</span></span>
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 407c0d8..d2ba3c7 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -4,5 +4,5 @@ pkgdown_sha: ~
articles:
included_modules: included_modules.html
making_modules: making_modules.html
-last_built: 2023-11-21T05:07Z
+last_built: 2023-11-23T17:20Z
diff --git a/docs/reference/ASM_fetch_code.html b/docs/reference/ASM_fetch_code.html
index 4d22c1a..f10603d 100644
--- a/docs/reference/ASM_fetch_code.html
+++ b/docs/reference/ASM_fetch_code.html
@@ -156,9 +156,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: including file</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: source: file.path(system.file(package="onbrand"), "templates", "report.docx")</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: dest: file.path("config","report.docx")</span>
diff --git a/docs/reference/ASM_fetch_dlfn.html b/docs/reference/ASM_fetch_dlfn.html
index 6aab6a3..34e5ad2 100644
--- a/docs/reference/ASM_fetch_dlfn.html
+++ b/docs/reference/ASM_fetch_dlfn.html
@@ -163,9 +163,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: including file</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: source: file.path(system.file(package="onbrand"), "templates", "report.docx")</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: dest: file.path("config","report.docx")</span>
diff --git a/docs/reference/ASM_fetch_state.html b/docs/reference/ASM_fetch_state.html
index 2b92222..21c4dc4 100644
--- a/docs/reference/ASM_fetch_state.html
+++ b/docs/reference/ASM_fetch_state.html
@@ -183,9 +183,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: including file</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: source: file.path(system.file(package="onbrand"), "templates", "report.docx")</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: dest: file.path("config","report.docx")</span>
@@ -623,10 +623,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "ASM"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ASM.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ASM.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/ASM_init_state.html b/docs/reference/ASM_init_state.html
index 49914f0..98feb8a 100644
--- a/docs/reference/ASM_init_state.html
+++ b/docs/reference/ASM_init_state.html
@@ -169,9 +169,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: including file</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: source: file.path(system.file(package="onbrand"), "templates", "report.docx")</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: dest: file.path("config","report.docx")</span>
@@ -593,10 +593,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "ASM"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ASM.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ASM.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/ASM_test_mksession.html b/docs/reference/ASM_test_mksession.html
index 2b7abb1..bad03e7 100644
--- a/docs/reference/ASM_test_mksession.html
+++ b/docs/reference/ASM_test_mksession.html
@@ -186,9 +186,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: including file</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: source: file.path(system.file(package="onbrand"), "templates", "report.docx")</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: dest: file.path("config","report.docx")</span>
diff --git a/docs/reference/ASM_write_state.html b/docs/reference/ASM_write_state.html
index 7907249..00a4642 100644
--- a/docs/reference/ASM_write_state.html
+++ b/docs/reference/ASM_write_state.html
@@ -173,9 +173,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: including file</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: source: file.path(system.file(package="onbrand"), "templates", "report.docx")</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: dest: file.path("config","report.docx")</span>
@@ -206,7 +206,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span> file <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext<span class="op">=</span><span class="st">".zip"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> mod_ids <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"UD"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: writing app state to file on server: </span>
-<span class="r-msg co"><span class="r-pr">#></span> → ASM: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/file1596455e8a5d.zip</span>
+<span class="r-msg co"><span class="r-pr">#></span> → ASM: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/file6d9dd82030e.zip</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: Generating reports (code only)</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: Generating report: xlsx</span>
<span class="r-msg co"><span class="r-pr">#></span> → ASM: appending report for module:DW id:DW priority:1</span>
diff --git a/docs/reference/DW_init_state.html b/docs/reference/DW_init_state.html
index c24e163..c80f9e3 100644
--- a/docs/reference/DW_init_state.html
+++ b/docs/reference/DW_init_state.html
@@ -1011,10 +1011,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/DW.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/DW.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/FG_append_report.html b/docs/reference/FG_append_report.html
index 6493f8f..c665a7c 100644
--- a/docs/reference/FG_append_report.html
+++ b/docs/reference/FG_append_report.html
@@ -177,9 +177,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">state</span></span></span>
<span class="r-in"><span><span class="co"># This will read in the default PowerPoint report template </span></span></span>
<span class="r-in"><span><span class="va">rpt</span> <span class="op">=</span> </span></span>
diff --git a/docs/reference/FG_build.html b/docs/reference/FG_build.html
index f67600e..57d3d6e 100644
--- a/docs/reference/FG_build.html
+++ b/docs/reference/FG_build.html
@@ -189,9 +189,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">session</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">session</span></span></span>
<span class="r-in"><span><span class="va">input</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">input</span></span></span>
<span class="r-in"><span></span></span>
@@ -218,11 +218,11 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span><span class="co"># If you made any changes to the actual figure, this will </span></span></span>
<span class="r-in"><span><span class="co"># force a rebuild of the current figure:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu">FG_build</span><span class="op">(</span> state<span class="op">=</span><span class="va">state</span>, del_row <span class="op">=</span> <span class="cn">NULL</span>, cmd <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># To create a new empty figure you can do this:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_new_fig.html">FG_new_fig</a></span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:96db745c38408478cb1788f44905a48a</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FG_extract_page.html b/docs/reference/FG_extract_page.html
index 2824564..11d9599 100644
--- a/docs/reference/FG_extract_page.html
+++ b/docs/reference/FG_extract_page.html
@@ -162,9 +162,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">session</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">session</span></span></span>
<span class="r-in"><span><span class="va">input</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">input</span></span></span>
<span class="r-in"><span></span></span>
@@ -191,11 +191,11 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span><span class="co"># If you made any changes to the actual figure, this will </span></span></span>
<span class="r-in"><span><span class="co"># force a rebuild of the current figure:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_build.html">FG_build</a></span><span class="op">(</span> state<span class="op">=</span><span class="va">state</span>, del_row <span class="op">=</span> <span class="cn">NULL</span>, cmd <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># To create a new empty figure you can do this:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_new_fig.html">FG_new_fig</a></span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:96db745c38408478cb1788f44905a48a</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FG_fetch_code.html b/docs/reference/FG_fetch_code.html
index 50cbf9d..9f80717 100644
--- a/docs/reference/FG_fetch_code.html
+++ b/docs/reference/FG_fetch_code.html
@@ -156,9 +156,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">state</span></span></span>
<span class="r-in"><span><span class="va">code</span> <span class="op">=</span> <span class="fu">FG_fetch_code</span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/cat.html" class="external-link">cat</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste</a></span><span class="op">(</span><span class="va">code</span>, collapse<span class="op">=</span><span class="st">"\n"</span><span class="op">)</span><span class="op">)</span></span></span>
diff --git a/docs/reference/FG_fetch_current_fig.html b/docs/reference/FG_fetch_current_fig.html
index c6c1da7..f414979 100644
--- a/docs/reference/FG_fetch_current_fig.html
+++ b/docs/reference/FG_fetch_current_fig.html
@@ -160,9 +160,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">session</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">session</span></span></span>
<span class="r-in"><span><span class="va">input</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">input</span></span></span>
<span class="r-in"><span></span></span>
@@ -189,11 +189,11 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span><span class="co"># If you made any changes to the actual figure, this will </span></span></span>
<span class="r-in"><span><span class="co"># force a rebuild of the current figure:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_build.html">FG_build</a></span><span class="op">(</span> state<span class="op">=</span><span class="va">state</span>, del_row <span class="op">=</span> <span class="cn">NULL</span>, cmd <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># To create a new empty figure you can do this:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_new_fig.html">FG_new_fig</a></span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:96db745c38408478cb1788f44905a48a</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FG_fetch_state.html b/docs/reference/FG_fetch_state.html
index 3a03a6f..f002c9a 100644
--- a/docs/reference/FG_fetch_state.html
+++ b/docs/reference/FG_fetch_state.html
@@ -1396,10 +1396,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD" "DW"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/FG.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/FG.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/FG_init_state.html b/docs/reference/FG_init_state.html
index 173e9ff..bcbc330 100644
--- a/docs/reference/FG_init_state.html
+++ b/docs/reference/FG_init_state.html
@@ -1154,10 +1154,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD" "DW"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/FG.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/FG.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/FG_new_fig.html b/docs/reference/FG_new_fig.html
index 9d688be..7822572 100644
--- a/docs/reference/FG_new_fig.html
+++ b/docs/reference/FG_new_fig.html
@@ -159,9 +159,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">session</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">session</span></span></span>
<span class="r-in"><span><span class="va">input</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">input</span></span></span>
<span class="r-in"><span></span></span>
@@ -188,11 +188,11 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span><span class="co"># If you made any changes to the actual figure, this will </span></span></span>
<span class="r-in"><span><span class="co"># force a rebuild of the current figure:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_build.html">FG_build</a></span><span class="op">(</span> state<span class="op">=</span><span class="va">state</span>, del_row <span class="op">=</span> <span class="cn">NULL</span>, cmd <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># To create a new empty figure you can do this:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu">FG_new_fig</span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:96db745c38408478cb1788f44905a48a</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FG_set_current_fig.html b/docs/reference/FG_set_current_fig.html
index 35f628c..9efb458 100644
--- a/docs/reference/FG_set_current_fig.html
+++ b/docs/reference/FG_set_current_fig.html
@@ -165,9 +165,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">session</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">session</span></span></span>
<span class="r-in"><span><span class="va">input</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">input</span></span></span>
<span class="r-in"><span></span></span>
@@ -194,11 +194,11 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span><span class="co"># If you made any changes to the actual figure, this will </span></span></span>
<span class="r-in"><span><span class="co"># force a rebuild of the current figure:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_build.html">FG_build</a></span><span class="op">(</span> state<span class="op">=</span><span class="va">state</span>, del_row <span class="op">=</span> <span class="cn">NULL</span>, cmd <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># To create a new empty figure you can do this:</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu"><a href="FG_new_fig.html">FG_new_fig</a></span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:96db745c38408478cb1788f44905a48a</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FG_test_mksession.html b/docs/reference/FG_test_mksession.html
index a0af4d8..3b8ccb2 100644
--- a/docs/reference/FG_test_mksession.html
+++ b/docs/reference/FG_test_mksession.html
@@ -181,9 +181,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FG_update_checksum.html b/docs/reference/FG_update_checksum.html
index a7248dc..f59f5bc 100644
--- a/docs/reference/FG_update_checksum.html
+++ b/docs/reference/FG_update_checksum.html
@@ -162,12 +162,12 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">state</span></span></span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="fu">FG_update_checksum</span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FM_fetch_app_info.html b/docs/reference/FM_fetch_app_info.html
index 75188cb..79f57a1 100644
--- a/docs/reference/FM_fetch_app_info.html
+++ b/docs/reference/FM_fetch_app_info.html
@@ -114,10 +114,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "Modules" </span>
<span class="r-out co"><span class="r-pr">#></span> [2] "ID: UD" </span>
<span class="r-out co"><span class="r-pr">#></span> [3] "type: UD" </span>
-<span class="r-out co"><span class="r-pr">#></span> [4] "FM_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
-<span class="r-out co"><span class="r-pr">#></span> [5] "MOD_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml" </span>
-<span class="r-out co"><span class="r-pr">#></span> [6] "User files: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM" </span>
-<span class="r-out co"><span class="r-pr">#></span> [7] "Log file: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/formods_log.txt" </span>
+<span class="r-out co"><span class="r-pr">#></span> [4] "FM_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [5] "MOD_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml" </span>
+<span class="r-out co"><span class="r-pr">#></span> [6] "User files: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM" </span>
+<span class="r-out co"><span class="r-pr">#></span> [7] "Log file: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/formods_log.txt" </span>
<span class="r-out co"><span class="r-pr">#></span> [8] "Package dependencies: janitor, readr, readxl" </span>
<span class="r-out co"><span class="r-pr">#></span> [9] " package * version date (UTC) lib source" </span>
<span class="r-out co"><span class="r-pr">#></span> [10] " abind 1.4-5 2016-07-21 [2] CRAN (R 4.2.0)" </span>
@@ -151,7 +151,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [38] " fontBitstreamVera 0.1.1 2017-02-01 [2] CRAN (R 4.2.0)" </span>
<span class="r-out co"><span class="r-pr">#></span> [39] " fontLiberation 0.1.0 2016-10-15 [2] CRAN (R 4.2.0)" </span>
<span class="r-out co"><span class="r-pr">#></span> [40] " fontquiver 0.2.1 2017-02-01 [2] CRAN (R 4.2.0)" </span>
-<span class="r-out co"><span class="r-pr">#></span> [41] " formods * 0.1.2 2023-11-21 [1] local" </span>
+<span class="r-out co"><span class="r-pr">#></span> [41] " formods * 0.1.2 2023-11-23 [1] local" </span>
<span class="r-out co"><span class="r-pr">#></span> [42] " fs 1.6.1 2023-02-06 [2] CRAN (R 4.2.0)" </span>
<span class="r-out co"><span class="r-pr">#></span> [43] " gdtools 0.3.3 2023-03-27 [2] CRAN (R 4.2.1)" </span>
<span class="r-out co"><span class="r-pr">#></span> [44] " generics 0.1.3 2022-07-05 [2] CRAN (R 4.2.0)" </span>
@@ -246,7 +246,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [133] " yaml 2.3.7 2023-01-23 [2] CRAN (R 4.2.0)" </span>
<span class="r-out co"><span class="r-pr">#></span> [134] " zip 2.2.2 2022-10-26 [2] CRAN (R 4.2.0)" </span>
<span class="r-out co"><span class="r-pr">#></span> [135] "" </span>
-<span class="r-out co"><span class="r-pr">#></span> [136] " [1] /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2" </span>
+<span class="r-out co"><span class="r-pr">#></span> [136] " [1] /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02" </span>
<span class="r-out co"><span class="r-pr">#></span> [137] " [2] /Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/library" </span>
</code></pre></div>
</div>
diff --git a/docs/reference/FM_fetch_app_state.html b/docs/reference/FM_fetch_app_state.html
index f2607a4..75f0c11 100644
--- a/docs/reference/FM_fetch_app_state.html
+++ b/docs/reference/FM_fetch_app_state.html
@@ -437,7 +437,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> <em>File loaded.</em></span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_UD$UD$data_file_local</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/TEST_DATA.xlsx"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/TEST_DATA.xlsx"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_UD$UD$data_file_ext</span>
<span class="r-out co"><span class="r-pr">#></span> [1] "xlsx"</span>
@@ -489,10 +489,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_UD$FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_UD$MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
diff --git a/docs/reference/FM_fetch_log_path.html b/docs/reference/FM_fetch_log_path.html
index 5d43439..72ec421 100644
--- a/docs/reference/FM_fetch_log_path.html
+++ b/docs/reference/FM_fetch_log_path.html
@@ -124,7 +124,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → UD: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → UD: State initialized</span>
<span class="r-in"><span><span class="fu">FM_fetch_log_path</span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/formods_log.txt"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/formods_log.txt"</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FM_fetch_user_files_path.html b/docs/reference/FM_fetch_user_files_path.html
index ec87dfb..ebe1511 100644
--- a/docs/reference/FM_fetch_user_files_path.html
+++ b/docs/reference/FM_fetch_user_files_path.html
@@ -105,7 +105,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">state</span></span></span>
<span class="r-in"><span><span class="va">user_dir</span> <span class="op">=</span> <span class="fu">FM_fetch_user_files_path</span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">user_dir</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM"</span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
diff --git a/docs/reference/FM_generate_report.html b/docs/reference/FM_generate_report.html
index 5895115..ee441e9 100644
--- a/docs/reference/FM_generate_report.html
+++ b/docs/reference/FM_generate_report.html
@@ -207,9 +207,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">session</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">session</span></span></span>
<span class="r-in"><span><span class="va">input</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">input</span></span></span>
<span class="r-in"><span></span></span>
diff --git a/docs/reference/FM_init_state.html b/docs/reference/FM_init_state.html
index 5b1d896..b3b9445 100644
--- a/docs/reference/FM_init_state.html
+++ b/docs/reference/FM_init_state.html
@@ -507,10 +507,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/FM_message.html b/docs/reference/FM_message.html
new file mode 100644
index 0000000..26438c1
--- /dev/null
+++ b/docs/reference/FM_message.html
@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Writes a message to the console depending on whether cli is
+installed or not."><title>Show Message to User — FM_message • formods</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Show Message to User — FM_message"><meta property="og:description" content="Writes a message to the console depending on whether cli is
+installed or not."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+<![endif]--></head><body>
+ <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
+
+
+ <nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-primary"><div class="container">
+
+ <a class="navbar-brand me-2" href="../index.html">formods</a>
+
+ <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.2</small>
+
+
+ <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <div id="navbar" class="collapse navbar-collapse ms-3">
+ <ul class="navbar-nav me-auto"><li class="nav-item dropdown">
+ <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown--tutorials">
+ <span class="fas fa fas fa-chalkboard-teacher"></span>
+
+ Tutorials
+ </a>
+ <div class="dropdown-menu" aria-labelledby="dropdown--tutorials">
+ <a class="dropdown-item" href="../articles/included_modules.html">Included Modules</a>
+ <a class="dropdown-item" href="../articles/making_modules.html">Making Modules</a>
+ </div>
+</li>
+<li class="active nav-item">
+ <a class="nav-link" href="../reference/index.html">
+ <span class="fas fa fas fa-hat-wizard"></span>
+
+ Functions
+ </a>
+</li>
+<li class="nav-item">
+ <a class="nav-link" href="../news/index.html">
+ <span class="fas fa fas fa-rss"></span>
+
+ News
+ </a>
+</li>
+ </ul><form class="form-inline my-2 my-lg-0" role="search">
+ <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
+
+ <ul class="navbar-nav"><li class="nav-item">
+ <a class="external-link nav-link" href="https://github.com/john-harrold/formods/" aria-label="github">
+ <span class="fab fa fab fa-github fa-lg"></span>
+
+ </a>
+</li>
+ </ul></div>
+
+
+ </div>
+</nav><div class="container template-reference-topic">
+<div class="row">
+ <main id="main" class="col-md-9"><div class="page-header">
+ <img src="../logo.png" class="logo" alt=""><h1>Show Message to User</h1>
+ <small class="dont-index">Source: <a href="https://github.com/john-harrold/formods/blob/HEAD/R/formods.R" class="external-link"><code>R/formods.R</code></a></small>
+ <div class="d-none name"><code>FM_message.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>Writes a message to the console depending on whether cli is
+installed or not.</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">FM_message</span><span class="op">(</span><span class="va">line</span>, escape_braces <span class="op">=</span> <span class="cn">TRUE</span>, entry_type <span class="op">=</span> <span class="st">"alert"</span><span class="op">)</span></span></code></pre></div>
+ </div>
+
+ <div class="section level2">
+ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
+ <dl><dt>line</dt>
+<dd><p>Text to display</p></dd>
+
+
+<dt>escape_braces</dt>
+<dd><p>Set to <code>TRUE</code> (default) to escape curly braces in the entry, set to <code>FALSE</code> to have the values interpreted.</p></dd>
+
+
+<dt>entry_type</dt>
+<dd><p>Set to either "alert"(default), "danger", "info", "success", or "warning"</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
+
+
+<p>Returns NULL</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">FM_message</span><span class="op">(</span><span class="st">"This is a normal message"</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#></span> → This is a normal message</span>
+<span class="r-out co"><span class="r-pr">#></span> NULL</span>
+<span class="r-in"><span><span class="fu">FM_message</span><span class="op">(</span><span class="st">"This is a danger message"</span>, entry_type<span class="op">=</span><span class="st">"danger"</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#></span> <span style="color: #BB0000;">✖</span> This is a danger message</span>
+<span class="r-out co"><span class="r-pr">#></span> NULL</span>
+<span class="r-in"><span><span class="fu">FM_message</span><span class="op">(</span><span class="st">"This is a info message"</span>, entry_type<span class="op">=</span><span class="st">"info"</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#></span> <span style="color: #00BBBB;">ℹ</span> This is a info message</span>
+<span class="r-out co"><span class="r-pr">#></span> NULL</span>
+<span class="r-in"><span><span class="fu">FM_message</span><span class="op">(</span><span class="st">"This is a success message"</span>, entry_type<span class="op">=</span><span class="st">"success"</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#></span> <span style="color: #00BB00;">✔</span> This is a success message</span>
+<span class="r-out co"><span class="r-pr">#></span> NULL</span>
+<span class="r-in"><span><span class="fu">FM_message</span><span class="op">(</span><span class="st">"This is a warning message"</span>, entry_type<span class="op">=</span><span class="st">"warning"</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#></span> <span style="color: #BBBB00;">!</span> This is a warning message</span>
+<span class="r-out co"><span class="r-pr">#></span> NULL</span>
+</code></pre></div>
+ </div>
+ </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
+ </nav></aside></div>
+
+
+ <footer><div class="pkgdown-footer-left">
+ <p></p><p>Developed by John Harrold.</p>
+</div>
+
+<div class="pkgdown-footer-right">
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/docs/reference/FM_set_mod_state.html b/docs/reference/FM_set_mod_state.html
index bdd8219..bc17658 100644
--- a/docs/reference/FM_set_mod_state.html
+++ b/docs/reference/FM_set_mod_state.html
@@ -451,7 +451,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> <em>File loaded.</em></span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $userData$FM$FM_UD$UD$data_file_local</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/TEST_DATA.xlsx"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/TEST_DATA.xlsx"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $userData$FM$FM_UD$UD$data_file_ext</span>
<span class="r-out co"><span class="r-pr">#></span> [1] "xlsx"</span>
@@ -503,10 +503,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $userData$FM$FM_UD$FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $userData$FM$FM_UD$MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> </span>
diff --git a/docs/reference/UD_attach_ds.html b/docs/reference/UD_attach_ds.html
index 09b1f23..d0033fa 100644
--- a/docs/reference/UD_attach_ds.html
+++ b/docs/reference/UD_attach_ds.html
@@ -539,7 +539,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> NULL</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $UD$data_file_local</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/test_data/TEST_DATA.xlsx"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/test_data/TEST_DATA.xlsx"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $UD$data_file_ext</span>
<span class="r-out co"><span class="r-pr">#></span> [1] ".xlsx"</span>
@@ -591,10 +591,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/UD_init_state.html b/docs/reference/UD_init_state.html
index 2e51865..44411b3 100644
--- a/docs/reference/UD_init_state.html
+++ b/docs/reference/UD_init_state.html
@@ -500,10 +500,10 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-out co"><span class="r-pr">#></span> [1] "UD"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $FM_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $MOD_yaml_file</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
</code></pre></div>
</div>
diff --git a/docs/reference/fers_builder.html b/docs/reference/fers_builder.html
index a24de3e..f365f5c 100644
--- a/docs/reference/fers_builder.html
+++ b/docs/reference/fers_builder.html
@@ -165,9 +165,9 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<span class="r-msg co"><span class="r-pr">#></span> → FG: dest: file.path("config","report.yaml")</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: State initialized</span>
<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a</span>
-<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe</span>
+<span class="r-msg co"><span class="r-pr">#></span> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255</span>
<span class="r-in"><span><span class="va">state</span> <span class="op">=</span> <span class="va">sess_res</span><span class="op">$</span><span class="va">state</span></span></span>
<span class="r-in"><span><span class="va">fb_res</span> <span class="op">=</span> <span class="fu">fers_builder</span><span class="op">(</span><span class="va">state</span><span class="op">)</span></span></span>
</code></pre></div>
diff --git a/docs/reference/index.html b/docs/reference/index.html
index d65b1c0..b1e536c 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -170,6 +170,11 @@ <h2 id="formods-general">formods general<a class="anchor" aria-label="anchor" hr
<dd>Adds Message to Log File and Displays it to the Console</dd>
</dl><dl><dt>
+ <code><a href="FM_message.html">FM_message()</a></code>
+ </dt>
+ <dd>Show Message to User</dd>
+ </dl><dl><dt>
+
<code><a href="FM_mk_error_fig.html">FM_mk_error_fig()</a></code>
</dt>
<dd>Generates `ggplot` Object with Error Message</dd>
diff --git a/docs/reference/new_module_template.html b/docs/reference/new_module_template.html
index 35a62f1..f90d0c5 100644
--- a/docs/reference/new_module_template.html
+++ b/docs/reference/new_module_template.html
@@ -122,35 +122,35 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu">new_module_template</span><span class="op">(</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#></span> $mc</span>
<span class="r-out co"><span class="r-pr">#></span> $mc$source</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ZZ_module_components.R"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ZZ_module_components.R"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $mc$dest</span>
<span class="r-out co"><span class="r-pr">#></span> [1] "NM_module_components.R"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $mc$dest_full</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/NM_module_components.R"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/NM_module_components.R"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $server</span>
<span class="r-out co"><span class="r-pr">#></span> $server$source</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ZZ_Server.R"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ZZ_Server.R"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $server$dest</span>
<span class="r-out co"><span class="r-pr">#></span> [1] "NM_Server.R"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $server$dest_full</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/NM_Server.R"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/NM_Server.R"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $yaml</span>
<span class="r-out co"><span class="r-pr">#></span> $yaml$source</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ZZ.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ZZ.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $yaml$dest</span>
<span class="r-out co"><span class="r-pr">#></span> [1] "NM.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> $yaml$dest_full</span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/NM.yaml"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/NM.yaml"</span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-out co"><span class="r-pr">#></span> </span>
<span class="r-in"><span></span></span>
diff --git a/docs/search.json b/docs/search.json
index 4e14875..f8700d9 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -1 +1 @@
-[{"path":"/articles/included_modules.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Included Modules","text":"ever make Shiny app think: Didn’t just stuff last week? creating data upload forms generating UI building ggplot figures certain components use apps. purpose formods create customizable Shiny modules allow many components created quickly can focus part app unique interesting. modules formods generates code dynamically produce underlying outputs. allows modules combined framework generate code allows state apps reproduced single script.","code":""},{"path":"/articles/included_modules.html","id":"implementation","dir":"Articles","previous_headings":"Introduction","what":"Implementation","title":"Included Modules","text":"module short name used functions namespaces. example upload data module use UD. use module need create appropriate UI elements well call module server. high level formods components individual modules configured YAML configuration files.","code":""},{"path":"/articles/included_modules.html","id":"avialable-modules","dir":"Articles","previous_headings":"","what":"Avialable modules","title":"Included Modules","text":"currently available modules listed table . SN column contains short name used identify module. individual HTML UI elements listed well UI outputs. Module SN htmlOutput Outputs App State Mangement ASM ui_asm_save_name, ui_asm_save_button, ui_asm_load_state ui_asm_msg, ui_asm_ace_code Upload Data UD ui_ud_load_data, ui_ud_select_sheets, ui_ud_text_load_result, ui_ud_data_preview ui_ud_ace_code Data Wrangling DW ui_dw_views, ui_dw_key, ui_dw_new_view, ui_dw_save_view, ui_dw_del_view, ui_dw_copy_view, ui_dw_add_element_button, ui_dw_select, ui_dw_new_element_row hot_dw_elements, hot_data_preview, ui_dw_msg, ui_dw_code Figure Generation FG ui_fg_curr_views, ui_fg_curr_figs, ui_fg_new_fig, ui_fg_save_fig, ui_fg_del_fig, ui_fg_copy_fig, ui_fg_fig_name, ui_fg_fig_notes, ui_fg_add_element_button, ui_fg_select, ui_fg_new_element_row, ui_fg_msg, ui_fg_slider_page hot_fg_elements, ui_fg_preview_ggplot, ui_fg_msg, ui_fg_code","code":""},{"path":"/articles/included_modules.html","id":"using-a-module","dir":"Articles","previous_headings":"Avialable modules","what":"Using a module","title":"Included Modules","text":"Using module requires two components: need add UI elements module, need add server component well. Take care use id UI server components. UI elements listed table . Also module formods contains example App file isolates UI component allow see ’s used. called XX_module_components.R, XX module short name. example see example upload data module run following copy file locally: want run App within package can just following:","code":"copy.file(system.file(package=\"formods\", \"templates\", \"UD_module_components.R\"), \"UD_module_components.R\") runApp(system.file(package=\"formods\", \"templates\", \"UD_module_components.R\"))"},{"path":"/articles/included_modules.html","id":"compact-ui-elements","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"Compact UI elements","title":"Included Modules","text":"Using module components script , can see whate UI element looks like behaves. allows granular control UI elements placement. module, formods provides single ui output place module UI components together. upload data module looks like : copy FM_compact.R file locally, can see used module: can run example see modules interact well:","code":"htmlOutput(NS(\"UD\", \"ui_ud_compact\")) copy.file(system.file(package=\"formods\", \"templates\", \"FM_compact.R\"), \"FM_compact.R\") runApp(system.file(package=\"formods\", \"templates\", \"FM_compact.R\"))"},{"path":"/articles/included_modules.html","id":"deployment","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"Deployment","title":"Included Modules","text":"deploy App need create App file appropriate ui server functions called App.R. create one : certain aspects app behave differently deployed. need indicate app deployed. can two ways. done setting deployed argument server functions TRUE.","code":"file.copy(from = system.file(package=\"formods\", \"templates\", \"FM_compact.R\"), to = \"App.R\")"},{"path":"/articles/included_modules.html","id":"server-functions","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"Server functions","title":"Included Modules","text":"module server function uses shortname followed underscore prefix. example server function named using convention: XX_Server(). XX module short name. example server function upload data module UD_Server(). minimum server take module ID, configuration file formods package, module configuration file, reactive object called react_state. react_state object used link reactions modules. different XX_module_components.R files shows use server functions module. Briefly, using UD module example following app server function:","code":"server <- function(input, output, session) { react_FM = reactiveValues() # Module server UD_Server(id=\"UD\", react_state=react_FM) }"},{"path":"/articles/included_modules.html","id":"yaml-configuration-files","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"YAML configuration files","title":"Included Modules","text":"formods individual modules configured YAML files. default, modules use included template YAML files. However, may want alter default formatting text. simply need make local copies files like : can modify files. use need point server functions instead default templates. following sections describe current modules use .","code":"copy.file(system.file(package=\"formods\", \"templates\", \"formods.yaml\"), \"formods.yaml\") copy.file(system.file(package=\"formods\", \"templates\", \"UD.yaml\"), \"UD.yaml\")"},{"path":"/articles/included_modules.html","id":"app-state-management-asm","dir":"Articles","previous_headings":"Avialable modules","what":"App State Management (ASM)","title":"Included Modules","text":"ASM module used manage app state. allows user save current app state load later time.","code":""},{"path":"/articles/included_modules.html","id":"upload-data-ud","dir":"Articles","previous_headings":"Avialable modules","what":"Upload Data (UD)","title":"Included Modules","text":"UD module allows users upload data files App. allow specify file types Excel files sheet used. Provides Data sets via: FM_fetch_ds()","code":""},{"path":"/articles/included_modules.html","id":"data-wrangling-dw","dir":"Articles","previous_headings":"Avialable modules","what":"Data Wrangling (DW)","title":"Included Modules","text":"DW module provides interface dplyr tidyr.used create chains data wrangling commands user can build transform data creating data views. DW module can use data UD module, can take list dataset. Provides Data views via: FM_fetch_ds() Reporting data views (Excel)","code":""},{"path":"/articles/included_modules.html","id":"figure-generation-fg","dir":"Articles","previous_headings":"Avialable modules","what":"Figure Generation (FG)","title":"Included Modules","text":"FG module provides interface ggplot allows user select original data set UD module well data views created DW module. user can create multiple figures. Provides Reporting figures (PowerPoint Word)","code":""},{"path":[]},{"path":"/articles/included_modules.html","id":"request-entity-too-large-","dir":"Articles","previous_headings":"Known Issues","what":"413 Request Entity too large.","title":"Included Modules","text":"running RStudio server (web browser) receive following message: 413 Request Entity large. problem lies NGINX server. proxy server used RStudio. issue limit maximum upload size NGINX server. solution edit configuration file (something like /etc/nginx/nginx.conf) set option client_mx_body_size something reasonable.","code":""},{"path":[]},{"path":"/articles/making_modules.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Making Modules","text":"vignette provide overview formods framework creating reproducable modules interact . module namespace mantained using module short name prefix functions. example figure generation module uses FG. want create module, please submit issue formods github repository following information: short name intend use brief description module list modules depends ","code":""},{"path":"/articles/making_modules.html","id":"current-modules","dir":"Articles","previous_headings":"Introduction","what":"Current modules","title":"Making Modules","text":"ASM - App State Management DW - Data Wrangling FG - Figure Generation FM - Formods UD - Upload Data MC - reserved word current modules development: NCA - Non-Compartmental Analysis MB - Model Builder","code":""},{"path":"/articles/making_modules.html","id":"formods-framework","dir":"Articles","previous_headings":"","what":"formods framework","title":"Making Modules","text":"get started need create template files. example assumes creating module package called mypackage running command git repository. Say module used produce widgets, short name MM stands Module: MM_module_components.R - app can used testing module highlighting different UI elements used within module (found inst/templates). MM_Server.R: bare bones file containing expected functions minimal inputs. (found R). MM.yaml: module configuration file contains minimal elements expected, can add fields suit modules needs (found inst/templates).","code":"use_formods(SN = \"MM\", Module_Name = \"My Module\", element = \"widgets\", package = \"mypackage\")"},{"path":"/articles/making_modules.html","id":"expected-functions","dir":"Articles","previous_headings":"","what":"Expected functions","title":"Making Modules","text":"module template create standard set functions . MM replaced whatever short name choose create templates. functions can customized specific module. optional can deleted. example MM_fetch_ds function needed module creates datasets provides modules use (like DW module exports data views used modules). modules designed create elements. example DW module creates data view elements, FG module used create figure elements, etc. MM_Server Shiny server function. MM_init_state Creates empty formods state module. MM_fetch_state module function fetch state. Within function interactivity. access elements Shiny input isolated. Based differences input elements (current state app) stored app state can used trigger different things. MM_fetch_code takes ’s first argument module state. called argument return character object containing code needed generate elements module represented app. can assume modules one depends defined previously. example FG module return code associated generating figures. appended code UD DW modules define loading dataset creation data views. modules code generated (e.g. ASM) just return NULL. MM_append_report module generates reportable outputs, function used append outputs overall reports generated formods. hasds Boolean variable indicating modules currently exportable datasets. isgood General return status funciton. Set FALSE errors encoutered. msgs character vector messages pass back user. label Text label dataset MOD_TYPE Short name type module. id module ID. DS Dataframe containing actual dataset. DSMETA Metadata describing DS. code Complete code build dataset. checksum Module checksum. DSchecksum Dataset checksum. isgood Boolean indicating exit status function. session value Shiny session variable (app) list (outside app) initialization. input value shiny input end session initialization. state App state. rsc react_state components. MM_new_element Creates new module element. MM_fetch_current_element Extracts current element state object. MM_set_current_element Sets current element provided value. MM_del_element Deletes current active element.","code":""},{"path":"/articles/making_modules.html","id":"expected-ui-components","dir":"Articles","previous_headings":"","what":"Expected UI components","title":"Making Modules","text":"ui_mm_compact UI output contains compact view module can called main ui functions App. composed individual UI elements shown MM_module_components.R file. allows user quick way utilize model (using ui_mm_compact), ability customize module UI manually arranging pieces found MM_module_components.R.","code":""},{"path":"/articles/making_modules.html","id":"module-interaction","dir":"Articles","previous_headings":"","what":"Module interaction","title":"Making Modules","text":"Say using UD module feed data DW module user goes back upload form uploads different data set. need trigger reset Data Wrangling module well tell larger app something changed.","code":""},{"path":"/articles/making_modules.html","id":"module-state-and-reacting-to-changes","dir":"Articles","previous_headings":"Module interaction","what":"Module state and reacting to changes","title":"Making Modules","text":"Changes module states detected react_state object. given module type \"MM\" module id \"ID\" detect changes reacting react_state[[\"ID\"]] looking changes checksum element : react_state[[\"ID\"]][[\"MM\"]][[\"checksum\"]] checksum checksum can used detect changes module. example UD module change uploaded file sheet selected currently uplo:waded file changes.","code":""},{"path":"/articles/making_modules.html","id":"helper-functions-in-formods","dir":"Articles","previous_headings":"","what":"Helper functions in formods","title":"Making Modules","text":"FM_le() - Creates log entries (le) displayed console. FM_tc() - can used evaluate code, trap errors, process results. has_changed() set_hold() - Used set hold one UI elements. prevents internal updating UI element based current value App. fetch_hold() - retrieve hold status UI element. remove_hold() - remove holds set UI element. ‘FM_build_comment()’ - creates comments strings form sections viewed RStudio. FM_add_ui_tooltip() - Attaches tooltip UI element. FM_init_state() - Called top module state initialization function create skeleton module state can build upon. FM_set_notification() - Within code can create notifications attach module state. FM_notify() - Used observeEvent() show notifications yet displayed. FM_set_mod_state() FM_fetch_mod_state() FM_set_ui_msg() FM_pretty_sort() - Used general sorting function try make sorted results prettier. FM_pause_screen() - Pauses screen something server side takes . FM_resume_screen() - Resumes activity (unpauses screen) ’re done pause. FM_fetch_data_format() - Creates formatting information display given data frame. examples require Shiny session variable formods state object. create examples objects needed demonstrate functions .","code":"library(formods) # This creates the state and session objects sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state session = sess_res$session # Here we load an example dataset into the df object. data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") sheet = \"DATA\" df = readxl::read_excel(path=data_file_local, sheet=sheet)"},{"path":"/articles/making_modules.html","id":"setting-holds-on-ui-elements","dir":"Articles","previous_headings":"Helper functions in formods","what":"Setting holds on UI elements","title":"Making Modules","text":"mechanics fetch state functions mean time fetch state called, UI elements App pulled placed app state. generally works well exceptions. main exception want UI element changes another UI element. Say example selection box UI id my_selection. want selection alter text input id my_text. However just poll ui elements may update my_text based changes my_selection overwritten current value my_text. prevent , need two things: processing my_selection need set hold my_text (done set_hold()). processing my_text need hold set. checked fetch_hold() Lastly need remove hold. done UI refreshed new text value populated my_text (appropriate reactions set). done observeEvent triggered everything else (priority -100 ): remove_hold_listen object contain inputs create holds.","code":"remove_hold_listen <- reactive({ list(input$my_selection) }) observeEvent(remove_hold_listen(), { # Once the UI has been regenerated we # remove any holds for this module state = MM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, react_state = react_state) FM_le(state, \"removing holds\") # Removing all holds for(hname in names(state[[\"MM\"]][[\"ui_hold\"]])){ remove_hold(state, session, hname) } }, priority = -100)"},{"path":"/articles/making_modules.html","id":"dataframe-formatting-information","dir":"Articles","previous_headings":"Helper functions in formods","what":"Dataframe formatting information","title":"Making Modules","text":"want tables pulldown menues based types data column can use FM_fetch_data_format() function. custom headers can used rhandsontable package. add subtext selection widget Shiny need use shinyWidgets package. alter formats shown need edit formods.yaml configuration file look FM\\(\\rightarrow\\)data_meta section.","code":"hfmt = FM_fetch_data_format(df, state) # Descriptive headers head(as.vector(unlist( hfmt[[\"col_heads\"]]))) #> [1] \"<span style='color:#3C8DBC'><b>ID<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [2] \"<span style='color:#3C8DBC'><b>TIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [3] \"<span style='color:#3C8DBC'><b>TIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [4] \"<span style='color:#3C8DBC'><b>NTIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [5] \"<span style='color:#3C8DBC'><b>NTIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [6] \"<span style='color:#3C8DBC'><b>TIME<\/b><br/><font size='-3'>num<\/font><\/span>\" # Subtext head(as.vector(unlist( hfmt[[\"col_subtext\"]]))) #> [1] \"num: 1,⋅⋅⋅,360\" \"num: 0,⋅⋅⋅,84\" \"num: 0,⋅⋅⋅,2016\" \"num: 0,⋅⋅⋅,42\" #> [5] \"num: 0,⋅⋅⋅,1008\" \"num: 0,⋅⋅⋅,2016\" hot = rhandsontable::rhandsontable( head(df), width = \"100%\", height = \"100%\", colHeaders = as.vector(unlist(hfmt[[\"col_heads\"]])), rowHeaders = NULL ) sel_subtext = as.vector(unlist( hfmt[[\"col_subtext\"]])) library(shinyWidgets) shinyWidgets::pickerInput( inputId = \"select_example\", choices = names(df), label = \"Select with subtext\", choicesOpt = list(subtext = sel_subtext))"},{"path":"/articles/making_modules.html","id":"notifications","dir":"Articles","previous_headings":"Helper functions in formods","what":"Notifications","title":"Making Modules","text":"Notifications created using shinybusy package produced two different functions: FM_set_notification() FM_notify(). done centralized fashion notifications added state object user information processed. set notification called Example Notification. Along timestamp set: timestamp used track prevent notification shown multiple times. Next need setup reactions display notifications. can create reactive expression inputs lead notification: Next use observeEvent() reactive expression trigger notifications. need use fetch state function molecule get state object notifications. FM_notify() called unprocessed notifications displayed:","code":"state = FM_set_notification(state, \"Something happened\", \"Example Notification\") toNotify <- reactive({ list(input$input1, input$input2) }) observeEvent(toNotify(), { state = MM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, react_state = react_state) # Triggering optional notifications notify_res = FM_notify(state = state, session = session) })"},{"path":"/articles/making_modules.html","id":"adding-tooltips","dir":"Articles","previous_headings":"Helper functions in formods","what":"Adding tooltips","title":"Making Modules","text":"Tooltips created interally using suggested prompter package. add tool tip ui element use FM_add_ui_tooltip() function. example add tool tip, need type harder! text input following:","code":"uiele = shiny::textInput( inputId = \"some_text\", label = \"You need to type harder!\") uiele = FM_add_ui_tooltip(state, uiele, tooltip = \"This is a tooltip\", position = \"left\")"},{"path":"/articles/making_modules.html","id":"pausing-the-screen","dir":"Articles","previous_headings":"Helper functions in formods","what":"Pausing the screen","title":"Making Modules","text":"pause screen shinybusy package also used. controlled two functions: FM_pause_screen() used pause screen /update pause message, FM_resume_screen() used end pause resume interaction user.","code":"FM_pause_screen(state, session) FM_resume_screen(state, session)"},{"path":"/articles/making_modules.html","id":"formods-state-objects","dir":"Articles","previous_headings":"","what":"formods state objects","title":"Making Modules","text":"create formods state object can following fields: yaml- Contents formods configuration file. MC - Contents module configuration file. MM - MM short name current module. MOD_TYPE ), store app information. (see ). MOD_TYPE - Short name module. id - ID module. FM_yaml_file - formods configuration file. MOD_yaml_file - Module configuration file. notifications - Contains notifications set user FM_set_notification().","code":""},{"path":"/articles/making_modules.html","id":"app-information-in-mm","dir":"Articles","previous_headings":"formods state objects","what":"App information in MM","title":"Making Modules","text":"field state$MM relatively free form reserved elements. reserved keyword : button_counters - Counter tracks button clicks ui_hold - List hold elements populated set_hold() isgood - Boolean variable indicating state module. ui_msg - Messaages returned UI captured errors populated FM_set_ui_msg() fields can store whatever else need module.","code":""},{"path":[]},{"path":"/articles/making_modules.html","id":"yaml-configuration-files","dir":"Articles","previous_headings":"","what":"YAML configuration files","title":"Making Modules","text":"","code":"# https://www.glyphicons.com/sets/basic/ #General formods (FM) configuration across modules FM: include: files: - file: source: 'file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\")' dest: 'file.path(\"config\",\"report.docx\")' - file: source: 'file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\")' dest: 'file.path(\"config\",\"report.pptx\")' - file: source: 'file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\")' dest: 'file.path(\"config\",\"report.yaml\")' # Some features (e.g. copy to clipboard) don't work when deployed deployed: FALSE #General code options for the modules code: theme: \"vibrant_ink\" showLineNumbers: TRUE # File name of the R script to contain generation code gen_file: run_analysis.R # This is the preamble used in script generation. It goes on the # top. Feel free to add to it if you need to. Note that packages should be # listed in the packages section at the same level. gen_preamble: |- # formods automated output ------------------------------------------------ # https://formods.ubiquity.tools/ rm(list=ls()) # Each module should have a packages section that lists the packages # needed for code genereated for that module. packages: [\"onbrand\", \"writexl\"] notifications: config: # You can put any arguments here that would be arguments for # config_notify(). See ?shinybusy::config_notify() for more information success: useFontAwesome: FALSE useIcon: FALSE background: \"#5bb85b\" failure: useFontAwesome: FALSE useIcon: FALSE background: \"#d9534f\" info: useFontAwesome: FALSE useIcon: FALSE background: \"#5bc0de\" warning: useFontAwesome: FALSE useIcon: FALSE background: \"#f0ac4d\" reporting: # enabled here controls reporting for the app. Individual modules can be # controlled in their respective configuration files enabled: TRUE # The content_init section is used to initialize reports. You shouldn't # change the xlsx rpt but the docx and pptx rpt can be altered to # use custom onbrand templates. The main thing is that you create an # object called rpt with the appropriate template type in it. You can # also do any preprocessing here as well such as adding default content or # doing any placeholder assignments you might want to use. The paths can # be absolute paths. If relative paths are used they will be relative to # the user directory (either the temp formods directory running in shiny # or the top level of the zip file structure when saving the app state). content_init: xlsx: |- rpt = list(summary = NULL, sheets = list()) docx: |- rpt = onbrand::read_template( template = file.path(\"config\", \"report.docx\"), mapping = file.path(\"config\", \"report.yaml\")) pptx: |- rpt = onbrand::read_template( template = file.path(\"config\", \"report.pptx\"), mapping = file.path(\"config\", \"report.yaml\")) ui: # See ?actionBttn for styles button_style: \"fill\" # Max size for picker inputs select_size: 10 color_green: \"#00BB8A\" color_red: \"#FF475E\" color_blue: \"#0088FF\" color_purple: \"#bd2cf4\" data_meta: # This controls the overall format of headers and the select subtext for # data frames with the following placeholders surrouned by ===: # COLOR - font color # NAME - colum name # LABEL - type label # RANGE - this depends on the nature of the data in the column: # - If there are between 1 and 3 values then those values are shown. # - If there are more than 3 values then the min and max are show. data_header: \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" subtext: \"===LABEL===: ===RANGE===\" # Separator when showing more than three in a column. For exmaple if you # had a dataset with 1,2,3,4,5,6 and many_sep was \",...,\" then it would # appear as \"1,...,6\" many_sep: \",⋅⋅⋅,\" # This controls the differences for different data types. Take the output # of typeof(df$colname) and put an entry for that output here. data_types: character: color: \"#DD4B39\" label: \"text\" double: color: \"#3C8DBC\" label: \"num\" integer: color: \"#3C8DBC\" label: \"num\" other: color: \"black\" label: \"other\" labels: # JMH remove this once the datset stuff has been moved over default_ds: \"Original data set\" user_files: use_tmpdir: TRUE logging: enabled: TRUE timestamp: TRUE timestamp_fmt: \"%Y-%m-%d %H:%M:%S\" log_file: \"formods_log.txt\" console: TRUE"},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"John Harrold. Author, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Harrold J (2023). formods: 'Shiny' Modules General Tasks. R package version 0.1.2, https://formods.ubiquity.tools/.","code":"@Manual{, title = {formods: 'Shiny' Modules for General Tasks}, author = {John Harrold}, year = {2023}, note = {R package version 0.1.2}, url = {https://formods.ubiquity.tools/}, }"},{"path":"/index.html","id":"formods-","dir":"","previous_headings":"","what":"Shiny Modules for General Tasks","title":"Shiny Modules for General Tasks","text":"Shiny apps can often make use key elements, formods provides modules common tasks (data upload, wragling data, figure genration saving app state). modules can react interact well generate code create reproducable analyses. formods also defines framework creating reactive modules. vignettes outline use modules well create modules within framework.","code":""},{"path":[]},{"path":"/index.html","id":"from-cran","dir":"","previous_headings":"","what":"From CRAN","title":"Shiny Modules for General Tasks","text":"can install released version formods CRAN :","code":"install.packages(\"formods\")"},{"path":"/index.html","id":"development-version","dir":"","previous_headings":"","what":"Development version","title":"Shiny Modules for General Tasks","text":"can install development version GitHub : Note formods depends onbrand need first install development version onbrand.","code":"# Installing devtools if it's not already installed if(system.file(package=\"devtools\") == \"\"){ install.packages(\"devtools\") } devtools::install_github(\"john-harrold/onbrand\", dependencies=TRUE) devtools::install_github(\"john-harrold/formods\", dependencies=TRUE)"},{"path":"/index.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting started","title":"Shiny Modules for General Tasks","text":"","code":"library(shiny) library(formods) runApp(system.file(package=\"formods\", \"templates\",\"FM_compact.R\"))"},{"path":"/reference/ASM_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Save State Server — ASM_Server","title":"Save State Server — ASM_Server","text":"Server function Save State Shiny Module","code":""},{"path":"/reference/ASM_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save State Server — ASM_Server","text":"","code":"ASM_Server( id, FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\"), deployed = FALSE, react_state = NULL, mod_ids )"},{"path":"/reference/ASM_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save State Server — ASM_Server","text":"id ID string corresponds ID used call modules UI elements FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL) mod_ids Vector module IDs order needed (used code generation).","code":""},{"path":"/reference/ASM_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Save State Server — ASM_Server","text":"UD Server object","code":""},{"path":"/reference/ASM_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Save State Server — ASM_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/ASM_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — ASM_fetch_code","title":"Fetch Module Code — ASM_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/ASM_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — ASM_fetch_code","text":"","code":"ASM_fetch_code(state)"},{"path":"/reference/ASM_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — ASM_fetch_code","text":"state ASM state ASM_fetch_state()","code":""},{"path":"/reference/ASM_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — ASM_fetch_code","text":"ASM module generate code","code":""},{"path":"/reference/ASM_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — ASM_fetch_code","text":"","code":"# Creating a state object for testing sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized state = sess_res$state code = ASM_fetch_code(state)"},{"path":"/reference/ASM_fetch_dlfn.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Download File Name — ASM_fetch_dlfn","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"Gets either file name specified user default value null","code":""},{"path":"/reference/ASM_fetch_dlfn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"","code":"ASM_fetch_dlfn(state, extension = \".zip\")"},{"path":"/reference/ASM_fetch_dlfn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"state ASM state ASM_fetch_state() extension File extension download (default: \".zip\")","code":""},{"path":"/reference/ASM_fetch_dlfn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"character object download file name","code":""},{"path":"/reference/ASM_fetch_dlfn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"","code":"# Creating a state object for testing sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized state = sess_res$state dlfn = ASM_fetch_dlfn(state) dlfn #> [1] \"Save Analysis.zip\""},{"path":"/reference/ASM_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch State Manager State — ASM_fetch_state","title":"Fetch State Manager State — ASM_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/ASM_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch State Manager State — ASM_fetch_state","text":"","code":"ASM_fetch_state(id, input, session, FM_yaml_file, MOD_yaml_file)"},{"path":"/reference/ASM_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch State Manager State — ASM_fetch_state","text":"id Shiny module ID input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section.","code":""},{"path":"/reference/ASM_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch State Manager State — ASM_fetch_state","text":"list containing current state app including default values yaml file well changes made user. list following structure: yaml: Full contents supplied yaml file. MC: Module components yaml file. ASM: isgood: Boolean object indicating file successfully loaded. checksum: MD5 sum loaded state file MOD_TYPE: Character data containing type module \"ASM\" id: Character data containing module id module session variable. FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section.","code":""},{"path":"/reference/ASM_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch State Manager State — ASM_fetch_state","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized session = sess_res$session input = sess_res$input # Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\") # We need to specify the ID of the ASM module id = \"ASM\" state = ASM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file) state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$code #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> #> $MC$show_log #> [1] 50 #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$formatting #> $MC$formatting$input_load_state #> $MC$formatting$input_load_state$width #> [1] \"100%\" #> #> #> $MC$formatting$ui_asm_save_name #> $MC$formatting$ui_asm_save_name$width #> [1] \"100%\" #> #> #> $MC$formatting$button_state_save #> $MC$formatting$button_state_save$size #> [1] \"sm\" #> #> $MC$formatting$button_state_save$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_xlsx #> $MC$formatting$button_rpt_xlsx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_xlsx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_pptx #> $MC$formatting$button_rpt_pptx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_pptx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_docx #> $MC$formatting$button_rpt_docx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_docx$block #> [1] TRUE #> #> #> $MC$formatting$switch_gen_reports #> $MC$formatting$switch_gen_reports$default #> [1] FALSE #> #> $MC$formatting$switch_gen_reports$right #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$inline #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$width #> NULL #> #> #> #> $MC$labels #> $MC$labels$ui_asm_save_name #> [1] \"Save Analysis\" #> #> $MC$labels$ui_asm_save_name_ph #> [1] \"my_analysis\" #> #> $MC$labels$ui_asm_switch_gen_rpts #> [1] \"Generate reports when saving.\" #> #> $MC$labels$save_state #> [1] \"Save\" #> #> $MC$labels$input_load_state #> [1] \"Load Analysis\" #> #> $MC$labels$upload_button #> [1] \"Load\" #> #> $MC$labels$upload_placeholder #> [1] \"Select analysis file\" #> #> $MC$labels$ui_asm_rpt_xlsx #> [1] \"xlsx\" #> #> $MC$labels$ui_asm_rpt_pptx #> [1] \"pptx\" #> #> $MC$labels$ui_asm_rpt_docx #> [1] \"docx\" #> #> $MC$labels$busy #> $MC$labels$busy$saving_state #> [1] \"Saving app state\" #> #> $MC$labels$busy$xlsx #> [1] \"Generating report: Excel\" #> #> $MC$labels$busy$docx #> [1] \"Generating report: Word\" #> #> $MC$labels$busy$pptx #> [1] \"Generating report: PowerPoint\" #> #> #> #> $MC$errors #> $MC$errors$bad_input #> [1] \"Input error message\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$input_tip #> [1] \"My tool tip\" #> #> #> #> #> $ASM #> $ASM$button_counters #> $ASM$button_counters$button_state_save #> [1] 0 #> #> $ASM$button_counters$button_rpt_xlsx #> [1] 0 #> #> $ASM$button_counters$button_rpt_docx #> [1] 0 #> #> $ASM$button_counters$button_rpt_pptx #> [1] 0 #> #> #> $ASM$ui_hold #> list() #> #> $ASM$ui_ids #> [1] \"button_state_save\" \"button_rpt_xlsx\" \"button_rpt_docx\" #> [4] \"button_rpt_pptx\" \"ui_asm_save_name\" \"switch_gen_rpts\" #> #> $ASM$isgood #> [1] TRUE #> #> $ASM$checksum #> [1] \"f9e884084b84794d762a535f3facec85\" #> #> $ASM$ui #> $ASM$ui$button_state_save #> [1] \"\" #> #> $ASM$ui$button_rpt_xlsx #> [1] \"\" #> #> $ASM$ui$button_rpt_docx #> [1] \"\" #> #> $ASM$ui$button_rpt_pptx #> [1] \"\" #> #> $ASM$ui$ui_asm_save_name #> [1] \"\" #> #> $ASM$ui$switch_gen_rpts #> [1] \"\" #> #> #> #> $MOD_TYPE #> [1] \"ASM\" #> #> $id #> [1] \"ASM\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ASM.yaml\" #>"},{"path":"/reference/ASM_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize ASM Module State — ASM_init_state","title":"Initialize ASM Module State — ASM_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/ASM_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize ASM Module State — ASM_init_state","text":"","code":"ASM_init_state(FM_yaml_file, MOD_yaml_file, id, session)"},{"path":"/reference/ASM_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize ASM Module State — ASM_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id ID string module. session Shiny session variable","code":""},{"path":"/reference/ASM_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize ASM Module State — ASM_init_state","text":"list containing empty ASM state","code":""},{"path":"/reference/ASM_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize ASM Module State — ASM_init_state","text":"","code":"# Within shiny the session variable will exist, # this creates an example here for testing purposes: sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized session = sess_res$session state = ASM_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\"), id = \"ASM\", session = session) #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$code #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> #> $MC$show_log #> [1] 50 #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$formatting #> $MC$formatting$input_load_state #> $MC$formatting$input_load_state$width #> [1] \"100%\" #> #> #> $MC$formatting$ui_asm_save_name #> $MC$formatting$ui_asm_save_name$width #> [1] \"100%\" #> #> #> $MC$formatting$button_state_save #> $MC$formatting$button_state_save$size #> [1] \"sm\" #> #> $MC$formatting$button_state_save$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_xlsx #> $MC$formatting$button_rpt_xlsx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_xlsx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_pptx #> $MC$formatting$button_rpt_pptx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_pptx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_docx #> $MC$formatting$button_rpt_docx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_docx$block #> [1] TRUE #> #> #> $MC$formatting$switch_gen_reports #> $MC$formatting$switch_gen_reports$default #> [1] FALSE #> #> $MC$formatting$switch_gen_reports$right #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$inline #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$width #> NULL #> #> #> #> $MC$labels #> $MC$labels$ui_asm_save_name #> [1] \"Save Analysis\" #> #> $MC$labels$ui_asm_save_name_ph #> [1] \"my_analysis\" #> #> $MC$labels$ui_asm_switch_gen_rpts #> [1] \"Generate reports when saving.\" #> #> $MC$labels$save_state #> [1] \"Save\" #> #> $MC$labels$input_load_state #> [1] \"Load Analysis\" #> #> $MC$labels$upload_button #> [1] \"Load\" #> #> $MC$labels$upload_placeholder #> [1] \"Select analysis file\" #> #> $MC$labels$ui_asm_rpt_xlsx #> [1] \"xlsx\" #> #> $MC$labels$ui_asm_rpt_pptx #> [1] \"pptx\" #> #> $MC$labels$ui_asm_rpt_docx #> [1] \"docx\" #> #> $MC$labels$busy #> $MC$labels$busy$saving_state #> [1] \"Saving app state\" #> #> $MC$labels$busy$xlsx #> [1] \"Generating report: Excel\" #> #> $MC$labels$busy$docx #> [1] \"Generating report: Word\" #> #> $MC$labels$busy$pptx #> [1] \"Generating report: PowerPoint\" #> #> #> #> $MC$errors #> $MC$errors$bad_input #> [1] \"Input error message\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$input_tip #> [1] \"My tool tip\" #> #> #> #> #> $ASM #> $ASM$button_counters #> $ASM$button_counters$button_state_save #> [1] 0 #> #> $ASM$button_counters$button_rpt_xlsx #> [1] 0 #> #> $ASM$button_counters$button_rpt_docx #> [1] 0 #> #> $ASM$button_counters$button_rpt_pptx #> [1] 0 #> #> #> $ASM$ui_hold #> list() #> #> $ASM$ui_ids #> [1] \"button_state_save\" \"button_rpt_xlsx\" \"button_rpt_docx\" #> [4] \"button_rpt_pptx\" \"ui_asm_save_name\" \"switch_gen_rpts\" #> #> $ASM$isgood #> [1] TRUE #> #> $ASM$checksum #> [1] \"f9e884084b84794d762a535f3facec85\" #> #> #> $MOD_TYPE #> [1] \"ASM\" #> #> $id #> [1] \"ASM\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ASM.yaml\" #>"},{"path":"/reference/ASM_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — ASM_test_mksession","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/ASM_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"","code":"ASM_test_mksession( session, id = \"ASM\", id_UD = \"UD\", id_DW = \"DW\", id_FG = \"FG\", full_session = TRUE )"},{"path":"/reference/ASM_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements id_UD ID string corresponds ID used call UD modules UI elements id_DW ID string corresponds ID used call DW modules UI elements id_FG ID string corresponds ID used call FG modules UI elements full_session Boolean indicate full test session created (default TRUE).","code":""},{"path":"/reference/ASM_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/ASM_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"","code":"sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized"},{"path":"/reference/ASM_write_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Write State to File for Saving — ASM_write_state","title":"Write State to File for Saving — ASM_write_state","text":"Called download handler used write saved state value null","code":""},{"path":"/reference/ASM_write_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write State to File for Saving — ASM_write_state","text":"","code":"ASM_write_state(state, session, file, mod_ids)"},{"path":"/reference/ASM_write_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write State to File for Saving — ASM_write_state","text":"state ASM state ASM_fetch_state() session Shiny session variable file File name write zipped state. mod_ids Vector module IDs order needed (used code generation).","code":""},{"path":"/reference/ASM_write_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write State to File for Saving — ASM_write_state","text":"function writes state return value.","code":""},{"path":"/reference/ASM_write_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Write State to File for Saving — ASM_write_state","text":"","code":"# \\donttest{ # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized session = sess_res$session input = sess_res$input # Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\") # We need to specify the ID of the ASM module id = \"ASM\" state = ASM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file) ASM_write_state(state, session, file = tempfile(fileext=\".zip\"), mod_ids = c(\"UD\")) #> → ASM: writing app state to file on server: #> → ASM: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/file1596455e8a5d.zip #> → ASM: Generating reports (code only) #> → ASM: Generating report: xlsx #> → ASM: appending report for module:DW id:DW priority:1 #> → ASM: appending report for module:FG id:FG priority:1 #> → ASM: Generating report: pptx #> → ASM: appending report for module:DW id:DW priority:1 #> → ASM: appending report for module:FG id:FG priority:1 #> → ASM: Generating report: docx #> → ASM: appending report for module:DW id:DW priority:1 #> → ASM: appending report for module:FG id:FG priority:1 #> → ASM: done writing app state #> NULL # }"},{"path":"/reference/DW_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Data Wrangling Server — DW_Server","title":"Data Wrangling Server — DW_Server","text":"Server function data wrangling module","code":""},{"path":"/reference/DW_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Data Wrangling Server — DW_Server","text":"","code":"DW_Server( id, id_ASM = \"ASM\", id_UD = \"UD\", FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"DW.yaml\"), deployed = FALSE, react_state = NULL )"},{"path":"/reference/DW_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Data Wrangling Server — DW_Server","text":"id ID string corresponds ID used call modules UI elements id_ASM ID string app state managment module used save load app states id_UD ID string upload data module used handle uploads name list element react_state data set stored. FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file DW main section. deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/DW_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Data Wrangling Server — DW_Server","text":"DW Server object","code":""},{"path":"/reference/DW_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Data Wrangling Server — DW_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/DW_add_wrangling_element.html","id":null,"dir":"Reference","previous_headings":"","what":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"Adds wrangling element current data view.","code":""},{"path":"/reference/DW_add_wrangling_element.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"","code":"DW_add_wrangling_element(state, dwb_res, dwee_res)"},{"path":"/reference/DW_add_wrangling_element.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"state DW state DW_fetch_state() dwb_res Output dwrs_builder() dwee_res Output dw_eval_element() returned UD_fetch_state().","code":""},{"path":"/reference/DW_add_wrangling_element.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"state data set attached","code":""},{"path":"/reference/DW_add_wrangling_element.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_append_report.html","id":null,"dir":"Reference","previous_headings":"","what":"Append Report Elements — DW_append_report","title":"Append Report Elements — DW_append_report","text":"Takes current state app appends data views xlsx report object.","code":""},{"path":"/reference/DW_append_report.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Append Report Elements — DW_append_report","text":"","code":"DW_append_report(state, rpt, rpttype, gen_code_only = FALSE)"},{"path":"/reference/DW_append_report.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Append Report Elements — DW_append_report","text":"state DW state DW_fetch_state() rpt Report current content report appended function. details structure see documentation FM_generate_report. rpttype Type report generate (supported \"xlsx\"). gen_code_only Boolean value indicating code generated (FALSE).","code":""},{"path":"/reference/DW_append_report.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Append Report Elements — DW_append_report","text":"list containing following elements isgood: Return status function. hasrptele: Boolean indicator module reportable elements. code: Code generate reporting elements. msgs: Messages passed back user. rpt: Report additions passed back user.","code":""},{"path":[]},{"path":"/reference/DW_append_report.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Append Report Elements — DW_append_report","text":"","code":"# We need a state object to use below sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state = sess_res$state rpt = list(summary = list(), sheets=list()) rpt_res = DW_append_report(state, rpt = rpt, rpttype = \"xlsx\") # Shows if report elements are present rpt_res$hasrptele #> [1] TRUE # Code chunk to generate report element cat(paste(rpt_res$code, collapse=\"\\n\")) #> rpt[[\"sheets\"]][[\"DW_myDS_1\"]]=DW_myDS_1 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_1\", #> Description=\"Observations\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_2\"]]=DW_myDS_2 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_2\", #> Description=\"PK 3mg SD IV\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_3\"]]=DW_myDS_3 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_3\", #> Description=\"PK 3mg MD SC (first dose)\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_4\"]]=DW_myDS_4 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_4\", #> Description=\"Parameters\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_5\"]]=DW_myDS_5 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_5\", #> Description=\"PK/PD 3mg SD IV w/BQL\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_6\"]]=DW_myDS_6 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_6\", #> Description=\"PK/PD 3mg MD SC (first dose) w/BQL\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_7\"]]=DW_myDS_7 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_7\", #> Description=\"PK 3mg SD IV w/BQL\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_8\"]]=DW_myDS_8 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_8\", #> Description=\"PK 3mg SD IV w/BQL w/dosing\" #> ) #> ) # Tabular summary of data views rpt_res$rpt$summary #> Sheet_Name Description #> 1 DW_myDS_1 Observations #> 2 DW_myDS_2 PK 3mg SD IV #> 3 DW_myDS_3 PK 3mg MD SC (first dose) #> 4 DW_myDS_4 Parameters #> 5 DW_myDS_5 PK/PD 3mg SD IV w/BQL #> 6 DW_myDS_6 PK/PD 3mg MD SC (first dose) w/BQL #> 7 DW_myDS_7 PK 3mg SD IV w/BQL #> 8 DW_myDS_8 PK 3mg SD IV w/BQL w/dosing"},{"path":"/reference/DW_attach_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Attach Data Set to DW State — DW_attach_ds","title":"Attach Data Set to DW State — DW_attach_ds","text":"Attaches dataset DW state supplied.","code":""},{"path":"/reference/DW_attach_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attach Data Set to DW State — DW_attach_ds","text":"","code":"DW_attach_ds(state, id_UD, session)"},{"path":"/reference/DW_attach_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attach Data Set to DW State — DW_attach_ds","text":"state DW state DW_fetch_state() id_UD ID string upload data module used handle uploads session Shiny session variable","code":""},{"path":"/reference/DW_attach_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attach Data Set to DW State — DW_attach_ds","text":"state data set attached","code":""},{"path":"/reference/DW_attach_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attach Data Set to DW State — DW_attach_ds","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # We also need a state variable state = sess_res$state # We need to identify the UD module with the data id_UD = \"UD\" state = DW_attach_ds(state, id_UD, session)"},{"path":"/reference/DW_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — DW_fetch_code","title":"Fetch Module Code — DW_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/DW_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — DW_fetch_code","text":"","code":"DW_fetch_code(state)"},{"path":"/reference/DW_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — DW_fetch_code","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — DW_fetch_code","text":"Character object vector lines code isgood)","code":""},{"path":"/reference/DW_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — DW_fetch_code","text":"","code":"# This will create a formods DW state object for the example sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state = sess_res$state code = DW_fetch_code(state) cat(code) #> # Observations ============================================================ #> DW_myDS_1 = myDS #> DW_myDS_1 = dplyr::filter(DW_myDS_1,EVID == 0) #> DW_myDS_1 = dplyr::filter(DW_myDS_1,DV != 0) #> DW_myDS_1 = dplyr::mutate(DW_myDS_1,IDCMT = paste0(ID, ', ', CMT)) #> #> # PK 3mg SD IV ============================================================ #> DW_myDS_2 = myDS #> DW_myDS_2 = dplyr::filter(DW_myDS_2,EVID == 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,DV != 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg MD SC (first dose) =============================================== #> DW_myDS_3 = myDS #> DW_myDS_3 = dplyr::filter(DW_myDS_3,EVID == 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DV != 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DOSE_NUM == 1) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,CMT %in% c(\"C_ng_ml\")) #> #> # Parameters ============================================================== #> DW_myDS_4 = myDS #> DW_myDS_4 = dplyr::group_by(DW_myDS_4,ID) #> DW_myDS_4 = dplyr::filter(DW_myDS_4,row_number()==1) #> DW_myDS_4 = dplyr::select(DW_myDS_4,ID, DOSE, DOSE_STR, Cohort, ROUTE, ka, CL, Vc, Vp, Q) #> DW_myDS_4 = tidyr::pivot_longer(DW_myDS_4, cols = c(\"ka\", \"CL\", \"Vc\", \"Vp\", \"Q\"), names_to = \"parameter\", values_to = \"values\") #> #> # PK/PD 3mg SD IV w/BQL =================================================== #> DW_myDS_5 = myDS #> DW_myDS_5 = dplyr::filter(DW_myDS_5,EVID == 0) #> DW_myDS_5 = dplyr::filter(DW_myDS_5,Cohort %in% c(\"SD 3 mg IV\")) #> #> # PK/PD 3mg MD SC (first dose) w/BQL ====================================== #> DW_myDS_6 = myDS #> DW_myDS_6 = dplyr::filter(DW_myDS_6,EVID == 0) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,DOSE_NUM == 1) #> #> # PK 3mg SD IV w/BQL ====================================================== #> DW_myDS_7 = myDS #> DW_myDS_7 = dplyr::filter(DW_myDS_7,EVID == 0) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg SD IV w/BQL w/dosing ============================================= #> DW_myDS_8 = myDS #> DW_myDS_8 = dplyr::filter(DW_myDS_8,Cohort %in% c(\"MD 3 mg IV\"))"},{"path":"/reference/DW_fetch_current_view.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Current Data View — DW_fetch_current_view","title":"Fetches Current Data View — DW_fetch_current_view","text":"Takes DW state returns current active view","code":""},{"path":"/reference/DW_fetch_current_view.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Current Data View — DW_fetch_current_view","text":"","code":"DW_fetch_current_view(state)"},{"path":"/reference/DW_fetch_current_view.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Current Data View — DW_fetch_current_view","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_fetch_current_view.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Current Data View — DW_fetch_current_view","text":"List containing details active data view. structure list structure state$DW$views output DW_fetch_state().","code":""},{"path":"/reference/DW_fetch_current_view.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Current Data View — DW_fetch_current_view","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_fetch_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Datasets — DW_fetch_ds","title":"Fetch Module Datasets — DW_fetch_ds","text":"Fetches datasets contained module.","code":""},{"path":"/reference/DW_fetch_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Datasets — DW_fetch_ds","text":"","code":"DW_fetch_ds(state)"},{"path":"/reference/DW_fetch_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Datasets — DW_fetch_ds","text":"state UD state UD_fetch_state()","code":""},{"path":"/reference/DW_fetch_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Datasets — DW_fetch_ds","text":"Character object vector lines code list containing following elements isgood: Return status function. hasds: Boolean indicator module datasets msgs: Messages passed back user. ds: List datasets. list element name R-object dataset. element following structure: label: Text label dataset MOD_TYPE: Short name type module. id: module ID DS: Dataframe containing actual dataset. DSMETA: Metadata describing DS, see FM_fetch_ds() details format. code: Complete code build dataset. checksum: Module checksum. DSchecksum: Dataset checksum.","code":""},{"path":"/reference/DW_fetch_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Datasets — DW_fetch_ds","text":"","code":"# We need a state variable sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state = sess_res$state ds = DW_fetch_ds(state)"},{"path":"/reference/DW_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Data Wrangling State — DW_fetch_state","title":"Fetch Data Wrangling State — DW_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/DW_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Data Wrangling State — DW_fetch_state","text":"","code":"DW_fetch_state( id, input, session, FM_yaml_file, MOD_yaml_file, id_UD, react_state )"},{"path":"/reference/DW_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Data Wrangling State — DW_fetch_state","text":"id Shiny module ID input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id_UD ID string upload data module used handle uploads name list element react_state data set stored. react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/DW_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Data Wrangling State — DW_fetch_state","text":"List containing current state DM module including default values yaml file well changes made user. structure list defined . yaml: Contents yaml file. MC: Module components yaml file. DW: Data wrangling state isgood: Boolean status state. FALSE dataset identified id_UD bad. checksum: MD5 sum indicating change datasets within view. Use trigger updates respose changes module. button_counters: List counters detect button clicks. code_previous: Loading code UD field. current_view: View id current active data wrangling view. UD: Copy \"UD\" field id_UD react_state input. ui: Current value form elements UI ui_hold: List hold elements disable updates full ui referesh complete. view_cntr: Counter tracking view ids, value contains id last view created. views: List data wrangling views. view following structure: checksum: MD5 sum WDS code: Code generate WDS start finish code_dw_only: Code just wrangling portion. code_previous: Code load data assign view object. elements_table: Table data wrangling elements. id: Character id (view_idx) idx: Numeric id (1) isgood: Boolean status data view. False evaluation fails key: User key (short description) view_ds_object_name: Object name data view WDS: Current value data view successful commands elements_table evaluated. MOD_TYPE: Character data containing type module \"DW\" id: Character data containing module id FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section. module session variable.","code":""},{"path":"/reference/DW_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Data Wrangling State — DW_fetch_state","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"DW.yaml\") # We need to specify both the DW module id as well as the # id of the UD module that feeds into it. id = \"DW\" id_UD = \"UD\" # Creating an empty state object state = DW_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, id_UD = \"UD\", react_state = NULL)"},{"path":"/reference/DW_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize DW Module State — DW_init_state","title":"Initialize DW Module State — DW_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/DW_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize DW Module State — DW_init_state","text":"","code":"DW_init_state(FM_yaml_file, MOD_yaml_file, id, id_UD, session)"},{"path":"/reference/DW_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize DW Module State — DW_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id Shiny module ID id_UD ID string upload data module used handle uploads name list element react_state data set stored. session Shiny session variable module (NULL)","code":""},{"path":"/reference/DW_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize DW Module State — DW_init_state","text":"list containing empty DW state","code":""},{"path":"/reference/DW_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize DW Module State — DW_init_state","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input state = DW_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"DW.yaml\"), id = \"DW\", id_UD = \"UD\", session = session) #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] TRUE #> #> $MC$compact$preview #> [1] TRUE #> #> $MC$compact$clip #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] TRUE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$notifications #> $MC$notifications$new_dw_element #> [1] \"Added element: ===ACTION=== (===DESC===)\" #> #> $MC$notifications$del_dw_element #> [1] \"Removed element: ===ACTION=== (===DESC===)\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data wrangling code\" #> #> $MC$tooltips$dw_elements #> [1] \"Current wrangling elements\" #> #> #> $MC$labels #> $MC$labels$tab_main #> [1] \"Wrangle\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$add_element #> [1] \"Add Operation/Action\" #> #> $MC$labels$fds_filter_column #> [1] \"Filter by Column\" #> #> $MC$labels$fds_filter_operator #> [1] \"Condition\" #> #> $MC$labels$fds_filter_rhs #> [1] \"Matching\" #> #> $MC$labels$fds_mutate_column #> [1] \"New or current column to alter\" #> #> $MC$labels$fds_mutate_rhs #> [1] \"New Value\" #> #> $MC$labels$fds_rename_column #> [1] \"Curret Column\" #> #> $MC$labels$fds_rename_rhs #> [1] \"New Name\" #> #> $MC$labels$fds_group_column #> [1] \"Columns to group\" #> #> $MC$labels$fds_longer_column #> [1] \"Columns to make longer\" #> #> $MC$labels$fds_longer_names #> [1] \"New column to contain names\" #> #> $MC$labels$fds_longer_values #> [1] \"New column to contain values\" #> #> $MC$labels$fds_wider_names #> [1] \"Column with names\" #> #> $MC$labels$fds_wider_values #> [1] \"Column with values\" #> #> $MC$labels$new_dw #> [1] \"New\" #> #> $MC$labels$del_dw #> [1] \"Delete\" #> #> $MC$labels$save_dw #> [1] \"Save\" #> #> $MC$labels$copy_dw #> [1] \"Copy\" #> #> $MC$labels$clip_dw #> [1] \"Code\" #> #> $MC$labels$ungroup_data #> [1] \"Removing current grouping\" #> #> $MC$labels$keep_onerow #> [1] \"Keep first row in current grouping\" #> #> $MC$labels$no_dataset #> [1] \"No dataset available to wrangle. You need to load a dataset to use this module.\" #> #> $MC$labels$no_dw_elements #> [1] \"No data wrangling elements defined yet\" #> #> $MC$labels$busy #> $MC$labels$busy$dv_update #> [1] \"Updating data views. Please be patient...\" #> #> #> #> $MC$errors #> $MC$errors$fds_filter_column #> [1] \"Filter column not specified.\" #> #> $MC$errors$fds_filter_operator #> [1] \"Filter condition not specified.\" #> #> $MC$errors$fds_filter_rhs #> [1] \"Filter RHS not specified.\" #> #> $MC$errors$fds_mutate_column #> [1] \"Mutate column not specified.\" #> #> $MC$errors$fds_mutate_rhs #> [1] \"Mutate RHS not specified.\" #> #> $MC$errors$fds_rename_column #> [1] \"Column to rename not specified.\" #> #> $MC$errors$fds_rename_rhs #> [1] \"New column name not specified.\" #> #> $MC$errors$fds_group_column #> [1] \"No columns to group specified.\" #> #> $MC$errors$fds_select_column #> [1] \"You must select at least one column to keep.\" #> #> $MC$errors$fds_longer_column #> [1] \"You must select at least one column to make longer.\" #> #> $MC$errors$fds_longer_names #> [1] \"You must supply a column for the names of the new longer dataset\" #> #> $MC$errors$fds_longer_values #> [1] \"You must supply a column for the values of the new longer dataset\" #> #> $MC$errors$fds_wider_names #> [1] \"You must select a column with the names.\" #> #> $MC$errors$`fds_wider_value s` #> [1] \"You must select a column with the values.\" #> #> $MC$errors$current_key #> [1] \"Short description\" #> #> $MC$errors$current_key_empty #> [1] \"The data view description field cannot be empty\" #> #> $MC$errors$unknown_action #> [1] \"The selection action is not supported.\" #> #> $MC$errors$no_rows #> [1] \"There are no rows in the data set.\" #> #> $MC$errors$element_not_added #> [1] \"Unable to add the data wrangling element:\" #> #> $MC$errors$fix_bad_element #> [1] \"There is a bad element in the data wrangling chain,\\nyou need to fix that before adding new elements\" #> #> #> $MC$operators #> $MC$operators[[1]] #> $MC$operators[[1]]$type #> [1] \"factor\" #> #> $MC$operators[[1]]$text #> [1] \"is one of\" #> #> $MC$operators[[1]]$rop #> [1] \"%in%\" #> #> #> $MC$operators[[2]] #> $MC$operators[[2]]$type #> [1] \"factor\" #> #> $MC$operators[[2]]$text #> [1] \"is not\" #> #> $MC$operators[[2]]$rop #> [1] \"!%in%\" #> #> #> $MC$operators[[3]] #> $MC$operators[[3]]$type #> [1] \"not_factor\" #> #> $MC$operators[[3]]$text #> [1] \"is within the range\" #> #> $MC$operators[[3]]$rop #> [1] \"within\" #> #> #> $MC$operators[[4]] #> $MC$operators[[4]]$type #> [1] \"not_factor\" #> #> $MC$operators[[4]]$text #> [1] \"is equal to\" #> #> $MC$operators[[4]]$rop #> [1] \"==\" #> #> #> $MC$operators[[5]] #> $MC$operators[[5]]$type #> [1] \"not_factor\" #> #> $MC$operators[[5]]$text #> [1] \"is not equal to\" #> #> $MC$operators[[5]]$rop #> [1] \"!=\" #> #> #> #> $MC$actions #> $MC$actions$filter #> $MC$actions$filter$choice #> [1] \"Filter\" #> #> $MC$actions$filter$subtext #> [1] \"Filter data\" #> #> #> $MC$actions$mutate #> $MC$actions$mutate$choice #> [1] \"Alter\" #> #> $MC$actions$mutate$subtext #> [1] \"Create new column or change existing column\" #> #> #> $MC$actions$rename #> $MC$actions$rename$choice #> [1] \"Rename\" #> #> $MC$actions$rename$subtext #> [1] \"Rename column\" #> #> #> $MC$actions$group #> $MC$actions$group$choice #> [1] \"Group\" #> #> $MC$actions$group$subtext #> [1] \"Group subsequent operations by columns\" #> #> #> $MC$actions$ungroup #> $MC$actions$ungroup$choice #> [1] \"Ungroup\" #> #> $MC$actions$ungroup$subtext #> [1] \"Removing groping\" #> #> #> $MC$actions$longer #> $MC$actions$longer$choice #> [1] \"Elongate\" #> #> $MC$actions$longer$subtext #> [1] \"Make Longer: rows to columns\" #> #> #> $MC$actions$wider #> $MC$actions$wider$choice #> [1] \"Widen\" #> #> $MC$actions$wider$subtext #> [1] \"Make Wider: columns to rows\" #> #> #> $MC$actions$onerow #> $MC$actions$onerow$choice #> [1] \"First Row\" #> #> $MC$actions$onerow$subtext #> [1] \"Keep only first row of grouped data\" #> #> #> $MC$actions$select #> $MC$actions$select$choice #> [1] \"Select\" #> #> $MC$actions$select$subtext #> [1] \"Choose columns to keep\" #> #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 400 #> #> #> $MC$formatting$dw_elements #> $MC$formatting$dw_elements$width #> [1] 600 #> #> $MC$formatting$dw_elements$height #> [1] 200 #> #> #> $MC$formatting$current_key #> $MC$formatting$current_key$width #> [1] 300 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 800 #> #> $MC$formatting$code$height #> [1] 300 #> #> #> $MC$formatting$button_dw_del #> $MC$formatting$button_dw_del$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_del$block #> [1] TRUE #> #> $MC$formatting$button_dw_del$tooltip #> [1] \"Delete the current data view.\" #> #> $MC$formatting$button_dw_del$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_clip #> $MC$formatting$button_dw_clip$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_clip$block #> [1] TRUE #> #> $MC$formatting$button_dw_clip$tooltip #> [1] \"Copy code to generate current data view to the clipboard.\" #> #> $MC$formatting$button_dw_clip$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_save #> $MC$formatting$button_dw_save$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_save$block #> [1] TRUE #> #> $MC$formatting$button_dw_save$tooltip #> [1] \"Save changes to data view name\" #> #> $MC$formatting$button_dw_save$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_copy #> $MC$formatting$button_dw_copy$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_copy$block #> [1] TRUE #> #> $MC$formatting$button_dw_copy$tooltip #> [1] \"Copy current data view to a new data view.\" #> #> $MC$formatting$button_dw_copy$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_new #> $MC$formatting$button_dw_new$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_new$block #> [1] TRUE #> #> $MC$formatting$button_dw_new$tooltip #> [1] \"Create a new empty data view.\" #> #> $MC$formatting$button_dw_new$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_add_element #> $MC$formatting$button_dw_add_element$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_add_element$block #> [1] TRUE #> #> #> #> $MC$code #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$packages #> [1] \"dplyr\" \"tidyr\" #> #> $MC$code$preamble #> [1] \"# Data wrangling ----------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"DW_myDS\" #> #> #> $DW #> $DW$button_counters #> $DW$button_counters$button_dw_add_element #> [1] 0 #> #> $DW$button_counters$button_dw_new #> [1] 0 #> #> $DW$button_counters$button_dw_del #> [1] 0 #> #> $DW$button_counters$button_dw_save #> [1] 0 #> #> $DW$button_counters$button_dw_copy #> [1] 0 #> #> #> $DW$ui_hold #> $DW$ui_hold$hot_dw_elements #> [1] FALSE #> #> $DW$ui_hold$current_key #> [1] FALSE #> #> $DW$ui_hold$select_dw_views #> [1] FALSE #> #> #> $DW$ui_ids #> [1] \"hot_dw_elements\" \"button_dw_add_element\" #> [3] \"button_dw_new\" \"button_dw_del\" #> [5] \"button_dw_copy\" \"button_dw_save\" #> [7] \"select_fds_filter_column\" \"select_fds_filter_operator\" #> [9] \"fds_filter_rhs\" \"select_fds_mutate_column\" #> [11] \"select_fds_mutate_rhs\" \"select_fds_rename_column\" #> [13] \"fds_rename_rhs\" \"current_key\" #> [15] \"select_fds_group_column\" \"select_fds_select_column\" #> [17] \"select_fds_longer_column\" \"select_fds_longer_values\" #> [19] \"select_fds_longer_names\" \"select_fds_wider_values\" #> [21] \"select_fds_wider_names\" \"select_dw_views\" #> [23] \"select_dw_element\" #> #> $DW$isgood #> [1] TRUE #> #> $DW$op_choices #> $DW$op_choices$factor #> is one of is not #> \"%in%\" \"!%in%\" #> #> $DW$op_choices$not_factor #> is within the range is equal to is not equal to #> \"within\" \"==\" \"!=\" #> #> #> $DW$view_cntr #> [1] 1 #> #> $DW$UD #> $DW$UD$isgood #> [1] TRUE #> #> $DW$UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $DW$UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> $DW$UD$object_name #> [1] \"myDS\" #> #> #> $DW$code_previous #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $DW$views #> $DW$views$view_1 #> $DW$views$view_1$isgood #> [1] TRUE #> #> $DW$views$view_1$id #> [1] \"view_1\" #> #> $DW$views$view_1$idx #> [1] 1 #> #> $DW$views$view_1$view_ds_object_name #> [1] \"DW_myDS_1\" #> #> $DW$views$view_1$code_previous #> [1] \"DW_myDS_1 = myDS\" #> #> $DW$views$view_1$key #> [1] \"data_view_1\" #> #> $DW$views$view_1$WDS #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> $DW$views$view_1$elements_table #> NULL #> #> $DW$views$view_1$checksum #> [1] \"b18a369b1e4d93010a04a56c7cde00c8\" #> #> $DW$views$view_1$code #> NULL #> #> $DW$views$view_1$code_dw_only #> NULL #> #> #> #> $DW$current_view #> [1] \"view_1\" #> #> $DW$checksum #> [1] \"5b0f0b05ee3ac7336a74c564bb6efdad\" #> #> #> $MOD_TYPE #> [1] \"DW\" #> #> $id #> [1] \"DW\" #> #> $dep_mod_ids #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/DW.yaml\" #>"},{"path":"/reference/DW_new_view.html","id":null,"dir":"Reference","previous_headings":"","what":"New Data Wrangling View — DW_new_view","title":"New Data Wrangling View — DW_new_view","text":"Appends new empty data wrangling view DW state object makes new view active view.","code":""},{"path":"/reference/DW_new_view.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"New Data Wrangling View — DW_new_view","text":"","code":"DW_new_view(state)"},{"path":"/reference/DW_new_view.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"New Data Wrangling View — DW_new_view","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_new_view.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"New Data Wrangling View — DW_new_view","text":"DW state object containing new data view view set current active view. See help DW_fetch_state() view format.","code":""},{"path":"/reference/DW_new_view.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"New Data Wrangling View — DW_new_view","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_set_current_view.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Current Data View — DW_set_current_view","title":"Sets Current Data View — DW_set_current_view","text":"Takes DW state updated view sets view current view_id","code":""},{"path":"/reference/DW_set_current_view.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Current Data View — DW_set_current_view","text":"","code":"DW_set_current_view(state, dw_view)"},{"path":"/reference/DW_set_current_view.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Current Data View — DW_set_current_view","text":"state DW state DW_fetch_state() dw_view Data view list format returned DW_fetch_current_view() (see structure state$DW$views output DW_fetch_state()).","code":""},{"path":"/reference/DW_set_current_view.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Current Data View — DW_set_current_view","text":"DW state object value dw_view set current view id.","code":""},{"path":"/reference/DW_set_current_view.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Current Data View — DW_set_current_view","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — DW_test_mksession","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/DW_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"","code":"DW_test_mksession(session, id = \"DW\", id_UD = \"UD\")"},{"path":"/reference/DW_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements id_UD ID string corresponds ID used call UD modules UI elements","code":""},{"path":"/reference/DW_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/DW_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"","code":"sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b"},{"path":"/reference/DW_update_checksum.html","id":null,"dir":"Reference","previous_headings":"","what":"Updates DW Module Checksum — DW_update_checksum","title":"Updates DW Module Checksum — DW_update_checksum","text":"Takes DW state updates checksum used trigger downstream updates","code":""},{"path":"/reference/DW_update_checksum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Updates DW Module Checksum — DW_update_checksum","text":"","code":"DW_update_checksum(state)"},{"path":"/reference/DW_update_checksum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Updates DW Module Checksum — DW_update_checksum","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_update_checksum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Updates DW Module Checksum — DW_update_checksum","text":"DW state object checksum updated","code":""},{"path":"/reference/DW_update_checksum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Updates DW Module Checksum — DW_update_checksum","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # We also need a state variable state = sess_res$state state = DW_update_checksum(state) #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b"},{"path":"/reference/FG_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Figure Generation Server — FG_Server","title":"Figure Generation Server — FG_Server","text":"Server function figure generation module","code":""},{"path":"/reference/FG_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Figure Generation Server — FG_Server","text":"","code":"FG_Server( id, FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"FG.yaml\"), id_ASM = \"ASM\", id_UD = \"UD\", id_DW = \"DW\", deployed = FALSE, react_state = NULL )"},{"path":"/reference/FG_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Figure Generation Server — FG_Server","text":"id ID string corresponds ID used call module's UI function FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id_ASM ID string app state management module used save load app states id_UD ID string upload data module used handle uploads name list element react_state data set stored. id_DW ID string data wrangling module process uploaded data deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/FG_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Figure Generation Server — FG_Server","text":"FG Server object","code":""},{"path":"/reference/FG_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Figure Generation Server — FG_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/FG_append_report.html","id":null,"dir":"Reference","previous_headings":"","what":"Append Report Elements — FG_append_report","title":"Append Report Elements — FG_append_report","text":"Description","code":""},{"path":"/reference/FG_append_report.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Append Report Elements — FG_append_report","text":"","code":"FG_append_report(state, rpt, rpttype, gen_code_only = FALSE)"},{"path":"/reference/FG_append_report.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Append Report Elements — FG_append_report","text":"state FG state FG_fetch_state() rpt Report current content report appended function. details structure see documentation FM_generate_report. rpttype Type report generate (supported \"xlsx\", \"pptx\", \"docx\"). gen_code_only Boolean value indicating code generated (FALSE).","code":""},{"path":"/reference/FG_append_report.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Append Report Elements — FG_append_report","text":"list containing following elements isgood: Return status function. hasrptele: Boolean indicator module reportable elements. code: Data wrangling R command. msgs: Messages passed back user. rpt: Report additions passed back user.","code":""},{"path":[]},{"path":"/reference/FG_append_report.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Append Report Elements — FG_append_report","text":"","code":"sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f state = sess_res$state # This will read in the default PowerPoint report template rpt = onbrand::read_template( template = system.file(package=\"onbrand\",\"templates\",\"report.pptx\"), mapping = system.file(package=\"onbrand\",\"templates\",\"report.yaml\")) rpt_res = FG_append_report(state = state, rpt = rpt, rpttype = \"pptx\", gen_code_only=TRUE) # Shows if report elements are present rpt_res$hasrptele #> [1] TRUE # Code chunk to generate report element cat(paste(rpt_res$code, collapse=\"\\n\")) #> # Figure Fig_1(1): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=1)), #> type = \"ggplot\"))) #> # Figure Fig_1(2): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=2)), #> type = \"ggplot\")))"},{"path":"/reference/FG_build.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluates Figure Generation Code — FG_build","title":"Evaluates Figure Generation Code — FG_build","text":"Takes current state rebuilds active figure. elements table row flagged deletion, deleted. cmd input NULL attempt append element figure.","code":""},{"path":"/reference/FG_build.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluates Figure Generation Code — FG_build","text":"","code":"FG_build( state, del_row = NULL, cmd = NULL, element = \"unknown\", desc = \"unknown\" )"},{"path":"/reference/FG_build.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluates Figure Generation Code — FG_build","text":"state FG state FG_fetch_state() del_row Row number deleted (NULL rows need deleted) cmd String containing plotting command. Set NULL initialize new figure force rebuild dataset update. element Short name figure element performed, eg. point desc Verbose description action performed","code":""},{"path":"/reference/FG_build.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Evaluates Figure Generation Code — FG_build","text":"list following elements isgood: Return status function. msgs: Messages passed back user. pages: List element containing ggplot object (p) code generate object (code)","code":""},{"path":"/reference/FG_build.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Evaluates Figure Generation Code — FG_build","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90 # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba"},{"path":"/reference/FG_extract_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Extracts Specific Page from Paginated Figure — FG_extract_page","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"Used extract specified page current figure.","code":""},{"path":"/reference/FG_extract_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"","code":"FG_extract_page(state, page)"},{"path":"/reference/FG_extract_page.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"state FG state FG_fetch_state() page Page number extract","code":""},{"path":"/reference/FG_extract_page.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"ggplot object specified page.","code":""},{"path":"/reference/FG_extract_page.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90 # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba"},{"path":"/reference/FG_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — FG_fetch_code","title":"Fetch Module Code — FG_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/FG_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — FG_fetch_code","text":"","code":"FG_fetch_code(state)"},{"path":"/reference/FG_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — FG_fetch_code","text":"state UD state FG_fetch_state()","code":""},{"path":"/reference/FG_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — FG_fetch_code","text":"Character object vector lines code","code":""},{"path":"/reference/FG_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — FG_fetch_code","text":"","code":"# This will create a populated FG state object: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f state = sess_res$state code = FG_fetch_code(state) cat(paste(code, collapse=\"\\n\")) #> # Individual profiles by cohort =========================================== #> FG_myp_1 = ggplot2::ggplot(data=DW_myDS_1) #> FG_myp_1 = FG_myp_1 + geom_line(aes(x=TIME_DY, y=DV, color=CMT, group=IDCMT)) #> FG_myp_1 = FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=1) #> FG_myp_1 = FG_myp_1 + scale_y_log10(limits=NULL) #> FG_myp_1 = FG_myp_1 + ggplot2::theme_light()"},{"path":"/reference/FG_fetch_current_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Current Figure — FG_fetch_current_fig","title":"Fetches Current Figure — FG_fetch_current_fig","text":"Takes FG state returns current active figure","code":""},{"path":"/reference/FG_fetch_current_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Current Figure — FG_fetch_current_fig","text":"","code":"FG_fetch_current_fig(state)"},{"path":"/reference/FG_fetch_current_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Current Figure — FG_fetch_current_fig","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/FG_fetch_current_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Current Figure — FG_fetch_current_fig","text":"List containing details active figure. structure list structure state$FG$figs output FG_fetch_state().","code":""},{"path":"/reference/FG_fetch_current_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Current Figure — FG_fetch_current_fig","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90 # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba"},{"path":"/reference/FG_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Figure Generation State — FG_fetch_state","title":"Fetch Figure Generation State — FG_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/FG_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Figure Generation State — FG_fetch_state","text":"","code":"FG_fetch_state( id, input, session, FM_yaml_file, MOD_yaml_file, id_ASM = NULL, id_UD = NULL, id_DW = NULL, react_state )"},{"path":"/reference/FG_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Figure Generation State — FG_fetch_state","text":"id Shiny module ID input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id_ASM ID string app state management module used save load app states id_UD ID string upload data module used handle uploads name list element react_state data set stored. id_DW ID string data wrangling module process uploaded data react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/FG_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Figure Generation State — FG_fetch_state","text":"list containing current state app including default values yaml file well changes made user. structure list defined : yaml: Contents yaml file. MC: Module components yaml file. FG: Data wrangling state isgood: Boolean status state. Currently just TRUE button_counters: List counters detect button clicks. ui_msg: Message returned users perform actions. ui: Current value form elements UI. ui_ids: Vector UI elements module. ui_hold: List hold elements disable updates full ui referesh complete. checksum: checksum FG module used detect changes module. aes_elements: Plot elements defined aesthetics (.e. X geom_X) current_fig: fig_id currently figure. fig_cntr: Counter figures, incremented time new figure created. DSV: Available data sets UD DW modules. figs: List figures. view following structure: add_isgood: JMH checksum: Checksum figure used detect changes figure. code: Code generate figure start finish. code_fg_only: Code just generate figure. code_previous: Code load /wrangle dataset. elements_table: Table figure generation elements. fg_object_name: JMH fig_dsview: Name dataset view current figure (also R object name dataset view). fobj: JMH id: Character id (fig_idx) idx: Numeric id (1) isgood: Boolean status figure. FALSE evaluation/build fails. key: Figure key acts title/caption (user editable) msgs: JMH notes: Figure notes (user editable) num_pages: JMH page: JMH MOD_TYPE: Character data containing type module \"DW\" id: Character data containing module id module session variable. FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section.","code":""},{"path":"/reference/FG_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Figure Generation State — FG_fetch_state","text":"","code":"# Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"FG.yaml\") # We need to specify both the FG module id as well as the # id of the UD module that feeds into it. id = \"FG\" id_UD = \"UD\" id_DW = \"DW\" # These would be the Shiny input and session variables input = list() session = list() # Creating an empty state object state = FG_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, id_UD = id_UD, id_DW = id_DW, react_state = NULL) #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: figure page change detected state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] TRUE #> #> $MC$compact$preview #> [1] \"ggplot\" #> #> $MC$compact$clip #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] TRUE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$manual #> $MC$tooltips$components$manual$x #> [1] \"Numeric location on the x-axis\" #> #> $MC$tooltips$components$manual$y #> [1] \"Numeric location on the y-axis\" #> #> $MC$tooltips$components$manual$color #> [1] \"A named color red, blue, green\" #> #> $MC$tooltips$components$manual$linetype #> [1] \"Specify either solid, dashed, dotted, dotdash, longdash or twodash\" #> #> $MC$tooltips$components$manual$shape #> [1] \"Open shapes: square (0), circle (1), triangle (2); Filled shapes: square (15), circle (16), triangle (17)\" #> #> $MC$tooltips$components$manual$size #> [1] \"Numeric value\" #> #> $MC$tooltips$components$manual$alpha #> [1] \"Numeric value between 0 (completely transparent) and 1 (solid)\" #> #> $MC$tooltips$components$manual$group #> NULL #> #> $MC$tooltips$components$manual$xintercept #> NULL #> #> $MC$tooltips$components$manual$yintercept #> NULL #> #> #> #> $MC$tooltips$ph #> $MC$tooltips$ph$notes #> [1] \"Optional figure notes that will be carried over and used in other elements (e.g. reporting).\" #> #> $MC$tooltips$ph$fig_key #> [1] \"Unique description used for referencing figures and in other elements (e.g. reporting).\" #> #> #> $MC$tooltips$show_code #> [1] \"Show figure generation code\" #> #> $MC$tooltips$fg_elements #> [1] \"Current figure elements\" #> #> #> $MC$labels #> $MC$labels$components #> $MC$labels$components$x #> [1] \"x-axis\" #> #> $MC$labels$components$y #> [1] \"y-axis\" #> #> $MC$labels$components$color #> [1] \"color\" #> #> $MC$labels$components$linetype #> [1] \"line type\" #> #> $MC$labels$components$fill #> [1] \"fill color\" #> #> $MC$labels$components$weight #> [1] \"weight\" #> #> $MC$labels$components$ymin #> [1] \"ymin\" #> #> $MC$labels$components$ymax #> [1] \"ymax\" #> #> $MC$labels$components$lower #> [1] \"lower\" #> #> $MC$labels$components$middle #> [1] \"middle\" #> #> $MC$labels$components$upper #> [1] \"upper\" #> #> $MC$labels$components$shape #> [1] \"shape\" #> #> $MC$labels$components$size #> [1] \"size\" #> #> $MC$labels$components$alpha #> [1] \"transparency\" #> #> $MC$labels$components$group #> [1] \"group\" #> #> $MC$labels$components$xintercept #> [1] \"x intercept\" #> #> $MC$labels$components$yintercept #> [1] \"y intercept\" #> #> $MC$labels$components$yscale #> [1] \"y-scale\" #> #> $MC$labels$components$xscale #> [1] \"x-scale\" #> #> $MC$labels$components$ylim #> [1] \"y limits\" #> #> $MC$labels$components$xlim #> [1] \"x limits\" #> #> #> $MC$labels$ph #> $MC$labels$ph$xlab #> [1] \"x-axis label\" #> #> $MC$labels$ph$ylab #> [1] \"y-axis label\" #> #> $MC$labels$ph$ggtitle #> [1] \"plot title\" #> #> $MC$labels$ph$notes #> [1] \"optional notes here\" #> #> $MC$labels$ph$fig_key #> [1] \"title/caption\" #> #> $MC$labels$ph$manual #> [1] \"Manual\" #> #> $MC$labels$ph$axlim #> [1] \"0.1, 1000 # Empty for auto\" #> #> #> $MC$labels$manual #> [1] \"Manual\" #> #> $MC$labels$not_used #> [1] \"Not Used\" #> #> $MC$labels$curr_figs_none #> [1] \"No figures yet created\" #> #> $MC$labels$no_fig_elements #> [1] \"Add figure elements\" #> #> $MC$labels$new_fig #> [1] \"New\" #> #> $MC$labels$save_fig #> [1] \"Save\" #> #> $MC$labels$del_fig #> [1] \"Delete\" #> #> $MC$labels$copy_fig #> [1] \"Copy\" #> #> $MC$labels$clip_fig #> [1] \"Code\" #> #> $MC$labels$upds_fig #> [1] \"Data set\" #> #> $MC$labels$add_ele #> [1] \"Add Figure Element\" #> #> $MC$labels$msg_bad_label #> [1] \"No labels were specified, unable to add element.\" #> #> $MC$labels$msg_bad_facet #> [1] \"At least one column must be selected to add a faceting element.\" #> #> $MC$labels$msg_bad_element #> [1] \"Unable to add the specified element: ===ELEMENT===\" #> #> $MC$labels$msg_bad_manual_comp #> [1] \"The plot element component ===COMP=== was specified manually but \\nno manual value was provided.\" #> #> $MC$labels$select_current_fig #> [1] \"Current figure\" #> #> $MC$labels$select_current_view #> [1] \"Data from\" #> #> $MC$labels$no_figures_defined #> [1] \"No figures have been defined. There are no data sources to create figures. You need to load data and create data views to use this module.\" #> #> $MC$labels$busy #> $MC$labels$busy$fig_update #> [1] \"Updating the current figure. Please be patient...\" #> #> #> #> $MC$errors #> $MC$errors$element_not_added #> [1] \"Unable to add the data figure element:\" #> #> $MC$errors$current_key_empty #> [1] \"The figure description field cannot be empty.\" #> #> $MC$errors$only_one_element #> [1] \"Only one element of ===ELEMENT=== type is allowed. The old ===ELEMENT=== will be replaced.\" #> #> #> $MC$elements #> $MC$elements$line #> $MC$elements$line$choice #> [1] \"Line\" #> #> $MC$elements$line$subtext #> [1] \"Continuous line\" #> #> $MC$elements$line$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"linetype\" \"size\" \"alpha\" #> #> $MC$elements$line$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$line$fcn #> [1] \"geom_line\" #> #> #> $MC$elements$point #> $MC$elements$point$choice #> [1] \"Point\" #> #> $MC$elements$point$subtext #> [1] \"Scatter plot\" #> #> $MC$elements$point$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"shape\" \"size\" \"alpha\" #> #> $MC$elements$point$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$point$fcn #> [1] \"geom_point\" #> #> #> $MC$elements$errorbar #> $MC$elements$errorbar$choice #> [1] \"Errobar\" #> #> $MC$elements$errorbar$subtext #> [1] \"Errorbars around points\" #> #> $MC$elements$errorbar$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"size\" \"alpha\" #> #> $MC$elements$errorbar$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$errorbar$fcn #> [1] \"geom_errorbar\" #> #> #> $MC$elements$hguide #> $MC$elements$hguide$choice #> [1] \"H-Guide\" #> #> $MC$elements$hguide$subtext #> [1] \"Horizontal guide\" #> #> $MC$elements$hguide$ui_aes #> [1] \"yintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$hguide$aes_req #> [1] \"yintercept\" #> #> $MC$elements$hguide$fcn #> [1] \"geom_hline\" #> #> #> $MC$elements$vguide #> $MC$elements$vguide$choice #> [1] \"V-Guide\" #> #> $MC$elements$vguide$subtext #> [1] \"Vertical guide\" #> #> $MC$elements$vguide$ui_aes #> [1] \"xintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$vguide$aes_req #> [1] \"xintercept\" #> #> $MC$elements$vguide$fcn #> [1] \"geom_vline\" #> #> #> $MC$elements$facet #> $MC$elements$facet$choice #> [1] \"Facet\" #> #> $MC$elements$facet$subtext #> [1] \"Facet by one or more variables\" #> #> #> $MC$elements$label #> $MC$elements$label$choice #> [1] \"Label\" #> #> $MC$elements$label$subtext #> [1] \"Label axes or plot title\" #> #> $MC$elements$label$ui_text #> [1] \"xlab\" \"ylab\" \"ggtitle\" #> #> #> $MC$elements$scales #> $MC$elements$scales$choice #> [1] \"Format Axes\" #> #> $MC$elements$scales$subtext #> [1] \"Axis scales and limits\" #> #> #> $MC$elements$smooth #> $MC$elements$smooth$choice #> [1] \"Smooth Trend\" #> #> $MC$elements$smooth$subtext #> [1] \"Smoothed conditional means\" #> #> $MC$elements$smooth$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"fill\" \"weight\" #> [7] \"linetype\" \"size\" \"alpha\" \"ymax\" \"ymin\" #> #> $MC$elements$smooth$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$smooth$fcn #> [1] \"geom_smooth\" #> #> #> $MC$elements$ribbon #> $MC$elements$ribbon$choice #> [1] \"Shaded Area\" #> #> $MC$elements$ribbon$subtext #> [1] \"Creating prediction intervals\" #> #> $MC$elements$ribbon$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"fill\" \"linetype\" #> [8] \"size\" \"alpha\" #> #> $MC$elements$ribbon$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$ribbon$fcn #> [1] \"geom_ribbon\" #> #> #> $MC$elements$boxplot #> $MC$elements$boxplot$choice #> [1] \"Boxplot\" #> #> $MC$elements$boxplot$subtext #> [1] \"Box and whiskers plot\" #> #> $MC$elements$boxplot$ui_aes #> [1] \"x\" \"y\" \"lower\" \"middle\" \"upper\" \"ymin\" #> [7] \"ymax\" \"color\" \"group\" \"fill\" \"weight\" \"linetype\" #> [13] \"size\" \"shape\" \"alpha\" #> #> $MC$elements$boxplot$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$boxplot$fcn #> [1] \"geom_boxplot\" #> #> #> #> $MC$formatting #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 800 #> #> $MC$formatting$code$height #> [1] 300 #> #> #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 400 #> #> #> $MC$formatting$select_fg_page #> $MC$formatting$select_fg_page$width #> [1] 1000 #> #> #> $MC$formatting$notes #> $MC$formatting$notes$width #> [1] \"560px\" #> #> $MC$formatting$notes$height #> [1] \"75px\" #> #> #> $MC$formatting$components #> $MC$formatting$components$aes #> $MC$formatting$components$aes$width #> [1] \"100px\" #> #> #> $MC$formatting$components$facet #> $MC$formatting$components$facet$width #> [1] \"200px\" #> #> #> $MC$formatting$components$label #> $MC$formatting$components$label$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axscale #> $MC$formatting$components$axscale$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axlim #> $MC$formatting$components$axlim$width #> [1] \"150px\" #> #> #> #> $MC$formatting$select_current_fig #> $MC$formatting$select_current_fig$width #> [1] 200 #> #> #> $MC$formatting$select_current_view #> $MC$formatting$select_current_view$width #> [1] 200 #> #> #> $MC$formatting$fg_elements #> $MC$formatting$fg_elements$width #> [1] 600 #> #> $MC$formatting$fg_elements$height #> [1] 200 #> #> #> $MC$formatting$faceting #> $MC$formatting$faceting$nrow #> [1] 3 #> #> $MC$formatting$faceting$ncol #> [1] 4 #> #> #> $MC$formatting$button_fig_del #> $MC$formatting$button_fig_del$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_del$block #> [1] TRUE #> #> $MC$formatting$button_fig_del$tooltip #> [1] \"Delete the current figure.\" #> #> $MC$formatting$button_fig_del$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_save #> $MC$formatting$button_fig_save$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_save$block #> [1] TRUE #> #> $MC$formatting$button_fig_save$tooltip #> [1] \"Save changes to caption, notes and data source.\" #> #> $MC$formatting$button_fig_save$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_clip #> $MC$formatting$button_fig_clip$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_clip$block #> [1] TRUE #> #> $MC$formatting$button_fig_clip$tooltip #> [1] \"Copy code to generate current figure to the clipboard.\" #> #> $MC$formatting$button_fig_clip$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_copy #> $MC$formatting$button_fig_copy$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_copy$block #> [1] TRUE #> #> $MC$formatting$button_fig_copy$tooltip #> [1] \"Copy current figure to a new figure.\" #> #> $MC$formatting$button_fig_copy$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_new #> $MC$formatting$button_fig_new$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_new$block #> [1] TRUE #> #> $MC$formatting$button_fig_new$tooltip #> [1] \"Create a new empty figure.\" #> #> $MC$formatting$button_fig_new$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_add #> $MC$formatting$button_fig_add$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_add$block #> [1] TRUE #> #> #> #> $MC$post_processing #> [1] \"===FGOBJ=== = ===FGOBJ=== + ggplot2::theme_light()\" #> #> $MC$fg_object_name #> [1] \"myp\" #> #> $MC$code #> $MC$code$packages #> [1] \"ggplot2\" \"ggforce\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Generating figures ------------------------------------------------------\" #> #> #> #> $FG #> $FG$button_counters #> $FG$button_counters$button_element_add #> [1] 0 #> #> $FG$button_counters$button_fig_save #> [1] 0 #> #> $FG$button_counters$button_fig_new #> [1] 0 #> #> $FG$button_counters$button_fig_del #> [1] 0 #> #> $FG$button_counters$button_fig_copy #> [1] 0 #> #> #> $FG$ui_hold #> $FG$ui_hold$hot_fg_elements #> [1] FALSE #> #> $FG$ui_hold$text_fig_key #> [1] FALSE #> #> $FG$ui_hold$text_fig_notes #> [1] FALSE #> #> $FG$ui_hold$select_current_view #> [1] FALSE #> #> $FG$ui_hold$select_current_fig #> [1] FALSE #> #> #> $FG$ui_ids #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" \"text_component_x_manual\" #> [9] \"text_component_y_manual\" \"text_component_color_manual\" #> [11] \"text_component_group_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_alpha_manual\" #> [15] \"select_component_shape\" \"text_component_shape_manual\" #> [17] \"select_component_ymin\" \"select_component_ymax\" #> [19] \"text_component_ymin_manual\" \"text_component_ymax_manual\" #> [21] \"select_component_yintercept\" \"text_component_yintercept_manual\" #> [23] \"select_component_xintercept\" \"text_component_xintercept_manual\" #> [25] \"select_component_fill\" \"select_component_weight\" #> [27] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [29] \"select_component_lower\" \"select_component_middle\" #> [31] \"select_component_upper\" \"text_component_lower_manual\" #> [33] \"text_component_middle_manual\" \"text_component_upper_manual\" #> [35] \"button_fig_new\" \"button_fig_save\" #> [37] \"button_fig_del\" \"button_fig_copy\" #> [39] \"button_element_add\" \"hot_fg_elements\" #> [41] \"text_fig_key\" \"text_fig_notes\" #> [43] \"text_component_xlab\" \"text_component_ylab\" #> [45] \"text_component_xlim\" \"text_component_ylim\" #> [47] \"text_component_ggtitle\" \"select_fg_page\" #> [49] \"select_current_fig\" \"select_current_view\" #> [51] \"select_component_facet\" \"select_component_xscale\" #> [53] \"select_component_yscale\" \"select_fg_element\" #> #> $FG$isgood #> [1] FALSE #> #> $FG$DSV #> $FG$DSV$isgood #> [1] FALSE #> #> $FG$DSV$hasds #> [1] FALSE #> #> $FG$DSV$catalog #> NULL #> #> $FG$DSV$modules #> list() #> #> $FG$DSV$ds #> list() #> #> #> $FG$fig_cntr #> [1] 0 #> #> $FG$aes_elements #> [1] \"line\" \"point\" \"errorbar\" \"hguide\" \"vguide\" \"smooth\" \"ribbon\" #> [8] \"boxplot\" #> #> $FG$auto_elements #> $FG$auto_elements$line #> $FG$auto_elements$line$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$line$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$point #> $FG$auto_elements$point$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" \"select_component_color\" #> [4] \"select_component_group\" \"select_component_shape\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$point$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_shape_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$errorbar #> $FG$auto_elements$errorbar$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" \"select_component_ymax\" #> [4] \"select_component_color\" \"select_component_group\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$errorbar$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$hguide #> $FG$auto_elements$hguide$ui_aes_select_id #> [1] \"select_component_yintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$hguide$ui_aes_manual_id #> [1] \"text_component_yintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$vguide #> $FG$auto_elements$vguide$ui_aes_select_id #> [1] \"select_component_xintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$vguide$ui_aes_manual_id #> [1] \"text_component_xintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$smooth #> $FG$auto_elements$smooth$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_fill\" \"select_component_weight\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" \"select_component_ymax\" #> [11] \"select_component_ymin\" #> #> $FG$auto_elements$smooth$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" \"text_component_ymax_manual\" #> [11] \"text_component_ymin_manual\" #> #> #> $FG$auto_elements$ribbon #> $FG$auto_elements$ribbon$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" #> [3] \"select_component_ymax\" \"select_component_color\" #> [5] \"select_component_group\" \"select_component_fill\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" #> #> $FG$auto_elements$ribbon$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_fill_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$boxplot #> $FG$auto_elements$boxplot$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_lower\" \"select_component_middle\" #> [5] \"select_component_upper\" \"select_component_ymin\" #> [7] \"select_component_ymax\" \"select_component_color\" #> [9] \"select_component_group\" \"select_component_fill\" #> [11] \"select_component_weight\" \"select_component_linetype\" #> [13] \"select_component_size\" \"select_component_shape\" #> [15] \"select_component_alpha\" #> #> $FG$auto_elements$boxplot$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_lower_manual\" \"text_component_middle_manual\" #> [5] \"text_component_upper_manual\" \"text_component_ymin_manual\" #> [7] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [9] \"text_component_group_manual\" \"text_component_fill_manual\" #> [11] \"text_component_weight_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_shape_manual\" #> [15] \"text_component_alpha_manual\" #> #> #> #> $FG$ui #> $FG$ui$select_component_x #> [1] \"\" #> #> $FG$ui$select_component_y #> [1] \"\" #> #> $FG$ui$select_component_color #> [1] \"\" #> #> $FG$ui$select_component_group #> [1] \"\" #> #> $FG$ui$select_component_linetype #> [1] \"\" #> #> $FG$ui$select_component_size #> [1] \"\" #> #> $FG$ui$select_component_alpha #> [1] \"\" #> #> $FG$ui$text_component_x_manual #> [1] \"\" #> #> $FG$ui$text_component_y_manual #> [1] \"\" #> #> $FG$ui$text_component_color_manual #> [1] \"\" #> #> $FG$ui$text_component_group_manual #> [1] \"\" #> #> $FG$ui$text_component_linetype_manual #> [1] \"\" #> #> $FG$ui$text_component_size_manual #> [1] \"\" #> #> $FG$ui$text_component_alpha_manual #> [1] \"\" #> #> $FG$ui$select_component_shape #> [1] \"\" #> #> $FG$ui$text_component_shape_manual #> [1] \"\" #> #> $FG$ui$select_component_ymin #> [1] \"\" #> #> $FG$ui$select_component_ymax #> [1] \"\" #> #> $FG$ui$text_component_ymin_manual #> [1] \"\" #> #> $FG$ui$text_component_ymax_manual #> [1] \"\" #> #> $FG$ui$select_component_yintercept #> [1] \"\" #> #> $FG$ui$text_component_yintercept_manual #> [1] \"\" #> #> $FG$ui$select_component_xintercept #> [1] \"\" #> #> $FG$ui$text_component_xintercept_manual #> [1] \"\" #> #> $FG$ui$select_component_fill #> [1] \"\" #> #> $FG$ui$select_component_weight #> [1] \"\" #> #> $FG$ui$text_component_fill_manual #> [1] \"\" #> #> $FG$ui$text_component_weight_manual #> [1] \"\" #> #> $FG$ui$select_component_lower #> [1] \"\" #> #> $FG$ui$select_component_middle #> [1] \"\" #> #> $FG$ui$select_component_upper #> [1] \"\" #> #> $FG$ui$text_component_lower_manual #> [1] \"\" #> #> $FG$ui$text_component_middle_manual #> [1] \"\" #> #> $FG$ui$text_component_upper_manual #> [1] \"\" #> #> $FG$ui$button_fig_new #> [1] \"\" #> #> $FG$ui$button_fig_save #> [1] \"\" #> #> $FG$ui$button_fig_del #> [1] \"\" #> #> $FG$ui$button_fig_copy #> [1] \"\" #> #> $FG$ui$button_element_add #> [1] \"\" #> #> $FG$ui$hot_fg_elements #> [1] \"\" #> #> $FG$ui$text_fig_key #> [1] \"\" #> #> $FG$ui$text_fig_notes #> [1] \"\" #> #> $FG$ui$text_component_xlab #> [1] \"\" #> #> $FG$ui$text_component_ylab #> [1] \"\" #> #> $FG$ui$text_component_xlim #> [1] \"\" #> #> $FG$ui$text_component_ylim #> [1] \"\" #> #> $FG$ui$text_component_ggtitle #> [1] \"\" #> #> $FG$ui$select_fg_page #> [1] \"\" #> #> $FG$ui$select_current_fig #> [1] \"\" #> #> $FG$ui$select_current_view #> [1] \"\" #> #> $FG$ui$select_component_facet #> [1] \"\" #> #> $FG$ui$select_component_xscale #> [1] \"\" #> #> $FG$ui$select_component_yscale #> [1] \"\" #> #> $FG$ui$select_fg_element #> [1] \"\" #> #> #> $FG$current_fig #> [1] \"\" #> #> $FG$figs #> $FG$figs[[1]] #> $FG$figs[[1]]$page #> [1] \"\" #> #> #> #> #> $MOD_TYPE #> [1] \"FG\" #> #> $id #> [1] \"FG\" #> #> $dep_mod_ids #> [1] \"UD\" \"DW\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/FG.yaml\" #>"},{"path":"/reference/FG_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize FG Module State — FG_init_state","title":"Initialize FG Module State — FG_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/FG_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize FG Module State — FG_init_state","text":"","code":"FG_init_state(FM_yaml_file, MOD_yaml_file, id, id_UD, id_DW, session)"},{"path":"/reference/FG_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize FG Module State — FG_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id Shiny module ID id_UD ID string upload data module used handle uploads name list element react_state data set stored. id_DW ID string data wrangling module process uploaded data session Shiny session variable","code":""},{"path":"/reference/FG_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize FG Module State — FG_init_state","text":"list containing empty app state object","code":""},{"path":"/reference/FG_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize FG Module State — FG_init_state","text":"","code":"# These would be the Shiny input and session variables input = list() session = list() state = FG_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"FG.yaml\"), id = \"FG\", id_UD = \"UD\", id_DW = \"DW\", session = session) #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] TRUE #> #> $MC$compact$preview #> [1] \"ggplot\" #> #> $MC$compact$clip #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] TRUE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$manual #> $MC$tooltips$components$manual$x #> [1] \"Numeric location on the x-axis\" #> #> $MC$tooltips$components$manual$y #> [1] \"Numeric location on the y-axis\" #> #> $MC$tooltips$components$manual$color #> [1] \"A named color red, blue, green\" #> #> $MC$tooltips$components$manual$linetype #> [1] \"Specify either solid, dashed, dotted, dotdash, longdash or twodash\" #> #> $MC$tooltips$components$manual$shape #> [1] \"Open shapes: square (0), circle (1), triangle (2); Filled shapes: square (15), circle (16), triangle (17)\" #> #> $MC$tooltips$components$manual$size #> [1] \"Numeric value\" #> #> $MC$tooltips$components$manual$alpha #> [1] \"Numeric value between 0 (completely transparent) and 1 (solid)\" #> #> $MC$tooltips$components$manual$group #> NULL #> #> $MC$tooltips$components$manual$xintercept #> NULL #> #> $MC$tooltips$components$manual$yintercept #> NULL #> #> #> #> $MC$tooltips$ph #> $MC$tooltips$ph$notes #> [1] \"Optional figure notes that will be carried over and used in other elements (e.g. reporting).\" #> #> $MC$tooltips$ph$fig_key #> [1] \"Unique description used for referencing figures and in other elements (e.g. reporting).\" #> #> #> $MC$tooltips$show_code #> [1] \"Show figure generation code\" #> #> $MC$tooltips$fg_elements #> [1] \"Current figure elements\" #> #> #> $MC$labels #> $MC$labels$components #> $MC$labels$components$x #> [1] \"x-axis\" #> #> $MC$labels$components$y #> [1] \"y-axis\" #> #> $MC$labels$components$color #> [1] \"color\" #> #> $MC$labels$components$linetype #> [1] \"line type\" #> #> $MC$labels$components$fill #> [1] \"fill color\" #> #> $MC$labels$components$weight #> [1] \"weight\" #> #> $MC$labels$components$ymin #> [1] \"ymin\" #> #> $MC$labels$components$ymax #> [1] \"ymax\" #> #> $MC$labels$components$lower #> [1] \"lower\" #> #> $MC$labels$components$middle #> [1] \"middle\" #> #> $MC$labels$components$upper #> [1] \"upper\" #> #> $MC$labels$components$shape #> [1] \"shape\" #> #> $MC$labels$components$size #> [1] \"size\" #> #> $MC$labels$components$alpha #> [1] \"transparency\" #> #> $MC$labels$components$group #> [1] \"group\" #> #> $MC$labels$components$xintercept #> [1] \"x intercept\" #> #> $MC$labels$components$yintercept #> [1] \"y intercept\" #> #> $MC$labels$components$yscale #> [1] \"y-scale\" #> #> $MC$labels$components$xscale #> [1] \"x-scale\" #> #> $MC$labels$components$ylim #> [1] \"y limits\" #> #> $MC$labels$components$xlim #> [1] \"x limits\" #> #> #> $MC$labels$ph #> $MC$labels$ph$xlab #> [1] \"x-axis label\" #> #> $MC$labels$ph$ylab #> [1] \"y-axis label\" #> #> $MC$labels$ph$ggtitle #> [1] \"plot title\" #> #> $MC$labels$ph$notes #> [1] \"optional notes here\" #> #> $MC$labels$ph$fig_key #> [1] \"title/caption\" #> #> $MC$labels$ph$manual #> [1] \"Manual\" #> #> $MC$labels$ph$axlim #> [1] \"0.1, 1000 # Empty for auto\" #> #> #> $MC$labels$manual #> [1] \"Manual\" #> #> $MC$labels$not_used #> [1] \"Not Used\" #> #> $MC$labels$curr_figs_none #> [1] \"No figures yet created\" #> #> $MC$labels$no_fig_elements #> [1] \"Add figure elements\" #> #> $MC$labels$new_fig #> [1] \"New\" #> #> $MC$labels$save_fig #> [1] \"Save\" #> #> $MC$labels$del_fig #> [1] \"Delete\" #> #> $MC$labels$copy_fig #> [1] \"Copy\" #> #> $MC$labels$clip_fig #> [1] \"Code\" #> #> $MC$labels$upds_fig #> [1] \"Data set\" #> #> $MC$labels$add_ele #> [1] \"Add Figure Element\" #> #> $MC$labels$msg_bad_label #> [1] \"No labels were specified, unable to add element.\" #> #> $MC$labels$msg_bad_facet #> [1] \"At least one column must be selected to add a faceting element.\" #> #> $MC$labels$msg_bad_element #> [1] \"Unable to add the specified element: ===ELEMENT===\" #> #> $MC$labels$msg_bad_manual_comp #> [1] \"The plot element component ===COMP=== was specified manually but \\nno manual value was provided.\" #> #> $MC$labels$select_current_fig #> [1] \"Current figure\" #> #> $MC$labels$select_current_view #> [1] \"Data from\" #> #> $MC$labels$no_figures_defined #> [1] \"No figures have been defined. There are no data sources to create figures. You need to load data and create data views to use this module.\" #> #> $MC$labels$busy #> $MC$labels$busy$fig_update #> [1] \"Updating the current figure. Please be patient...\" #> #> #> #> $MC$errors #> $MC$errors$element_not_added #> [1] \"Unable to add the data figure element:\" #> #> $MC$errors$current_key_empty #> [1] \"The figure description field cannot be empty.\" #> #> $MC$errors$only_one_element #> [1] \"Only one element of ===ELEMENT=== type is allowed. The old ===ELEMENT=== will be replaced.\" #> #> #> $MC$elements #> $MC$elements$line #> $MC$elements$line$choice #> [1] \"Line\" #> #> $MC$elements$line$subtext #> [1] \"Continuous line\" #> #> $MC$elements$line$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"linetype\" \"size\" \"alpha\" #> #> $MC$elements$line$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$line$fcn #> [1] \"geom_line\" #> #> #> $MC$elements$point #> $MC$elements$point$choice #> [1] \"Point\" #> #> $MC$elements$point$subtext #> [1] \"Scatter plot\" #> #> $MC$elements$point$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"shape\" \"size\" \"alpha\" #> #> $MC$elements$point$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$point$fcn #> [1] \"geom_point\" #> #> #> $MC$elements$errorbar #> $MC$elements$errorbar$choice #> [1] \"Errobar\" #> #> $MC$elements$errorbar$subtext #> [1] \"Errorbars around points\" #> #> $MC$elements$errorbar$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"size\" \"alpha\" #> #> $MC$elements$errorbar$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$errorbar$fcn #> [1] \"geom_errorbar\" #> #> #> $MC$elements$hguide #> $MC$elements$hguide$choice #> [1] \"H-Guide\" #> #> $MC$elements$hguide$subtext #> [1] \"Horizontal guide\" #> #> $MC$elements$hguide$ui_aes #> [1] \"yintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$hguide$aes_req #> [1] \"yintercept\" #> #> $MC$elements$hguide$fcn #> [1] \"geom_hline\" #> #> #> $MC$elements$vguide #> $MC$elements$vguide$choice #> [1] \"V-Guide\" #> #> $MC$elements$vguide$subtext #> [1] \"Vertical guide\" #> #> $MC$elements$vguide$ui_aes #> [1] \"xintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$vguide$aes_req #> [1] \"xintercept\" #> #> $MC$elements$vguide$fcn #> [1] \"geom_vline\" #> #> #> $MC$elements$facet #> $MC$elements$facet$choice #> [1] \"Facet\" #> #> $MC$elements$facet$subtext #> [1] \"Facet by one or more variables\" #> #> #> $MC$elements$label #> $MC$elements$label$choice #> [1] \"Label\" #> #> $MC$elements$label$subtext #> [1] \"Label axes or plot title\" #> #> $MC$elements$label$ui_text #> [1] \"xlab\" \"ylab\" \"ggtitle\" #> #> #> $MC$elements$scales #> $MC$elements$scales$choice #> [1] \"Format Axes\" #> #> $MC$elements$scales$subtext #> [1] \"Axis scales and limits\" #> #> #> $MC$elements$smooth #> $MC$elements$smooth$choice #> [1] \"Smooth Trend\" #> #> $MC$elements$smooth$subtext #> [1] \"Smoothed conditional means\" #> #> $MC$elements$smooth$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"fill\" \"weight\" #> [7] \"linetype\" \"size\" \"alpha\" \"ymax\" \"ymin\" #> #> $MC$elements$smooth$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$smooth$fcn #> [1] \"geom_smooth\" #> #> #> $MC$elements$ribbon #> $MC$elements$ribbon$choice #> [1] \"Shaded Area\" #> #> $MC$elements$ribbon$subtext #> [1] \"Creating prediction intervals\" #> #> $MC$elements$ribbon$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"fill\" \"linetype\" #> [8] \"size\" \"alpha\" #> #> $MC$elements$ribbon$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$ribbon$fcn #> [1] \"geom_ribbon\" #> #> #> $MC$elements$boxplot #> $MC$elements$boxplot$choice #> [1] \"Boxplot\" #> #> $MC$elements$boxplot$subtext #> [1] \"Box and whiskers plot\" #> #> $MC$elements$boxplot$ui_aes #> [1] \"x\" \"y\" \"lower\" \"middle\" \"upper\" \"ymin\" #> [7] \"ymax\" \"color\" \"group\" \"fill\" \"weight\" \"linetype\" #> [13] \"size\" \"shape\" \"alpha\" #> #> $MC$elements$boxplot$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$boxplot$fcn #> [1] \"geom_boxplot\" #> #> #> #> $MC$formatting #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 800 #> #> $MC$formatting$code$height #> [1] 300 #> #> #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 400 #> #> #> $MC$formatting$select_fg_page #> $MC$formatting$select_fg_page$width #> [1] 1000 #> #> #> $MC$formatting$notes #> $MC$formatting$notes$width #> [1] \"560px\" #> #> $MC$formatting$notes$height #> [1] \"75px\" #> #> #> $MC$formatting$components #> $MC$formatting$components$aes #> $MC$formatting$components$aes$width #> [1] \"100px\" #> #> #> $MC$formatting$components$facet #> $MC$formatting$components$facet$width #> [1] \"200px\" #> #> #> $MC$formatting$components$label #> $MC$formatting$components$label$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axscale #> $MC$formatting$components$axscale$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axlim #> $MC$formatting$components$axlim$width #> [1] \"150px\" #> #> #> #> $MC$formatting$select_current_fig #> $MC$formatting$select_current_fig$width #> [1] 200 #> #> #> $MC$formatting$select_current_view #> $MC$formatting$select_current_view$width #> [1] 200 #> #> #> $MC$formatting$fg_elements #> $MC$formatting$fg_elements$width #> [1] 600 #> #> $MC$formatting$fg_elements$height #> [1] 200 #> #> #> $MC$formatting$faceting #> $MC$formatting$faceting$nrow #> [1] 3 #> #> $MC$formatting$faceting$ncol #> [1] 4 #> #> #> $MC$formatting$button_fig_del #> $MC$formatting$button_fig_del$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_del$block #> [1] TRUE #> #> $MC$formatting$button_fig_del$tooltip #> [1] \"Delete the current figure.\" #> #> $MC$formatting$button_fig_del$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_save #> $MC$formatting$button_fig_save$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_save$block #> [1] TRUE #> #> $MC$formatting$button_fig_save$tooltip #> [1] \"Save changes to caption, notes and data source.\" #> #> $MC$formatting$button_fig_save$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_clip #> $MC$formatting$button_fig_clip$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_clip$block #> [1] TRUE #> #> $MC$formatting$button_fig_clip$tooltip #> [1] \"Copy code to generate current figure to the clipboard.\" #> #> $MC$formatting$button_fig_clip$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_copy #> $MC$formatting$button_fig_copy$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_copy$block #> [1] TRUE #> #> $MC$formatting$button_fig_copy$tooltip #> [1] \"Copy current figure to a new figure.\" #> #> $MC$formatting$button_fig_copy$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_new #> $MC$formatting$button_fig_new$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_new$block #> [1] TRUE #> #> $MC$formatting$button_fig_new$tooltip #> [1] \"Create a new empty figure.\" #> #> $MC$formatting$button_fig_new$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_add #> $MC$formatting$button_fig_add$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_add$block #> [1] TRUE #> #> #> #> $MC$post_processing #> [1] \"===FGOBJ=== = ===FGOBJ=== + ggplot2::theme_light()\" #> #> $MC$fg_object_name #> [1] \"myp\" #> #> $MC$code #> $MC$code$packages #> [1] \"ggplot2\" \"ggforce\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Generating figures ------------------------------------------------------\" #> #> #> #> $FG #> $FG$button_counters #> $FG$button_counters$button_element_add #> [1] 0 #> #> $FG$button_counters$button_fig_save #> [1] 0 #> #> $FG$button_counters$button_fig_new #> [1] 0 #> #> $FG$button_counters$button_fig_del #> [1] 0 #> #> $FG$button_counters$button_fig_copy #> [1] 0 #> #> #> $FG$ui_hold #> $FG$ui_hold$hot_fg_elements #> [1] FALSE #> #> $FG$ui_hold$text_fig_key #> [1] FALSE #> #> $FG$ui_hold$text_fig_notes #> [1] FALSE #> #> $FG$ui_hold$select_current_view #> [1] FALSE #> #> $FG$ui_hold$select_current_fig #> [1] FALSE #> #> #> $FG$ui_ids #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" \"text_component_x_manual\" #> [9] \"text_component_y_manual\" \"text_component_color_manual\" #> [11] \"text_component_group_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_alpha_manual\" #> [15] \"select_component_shape\" \"text_component_shape_manual\" #> [17] \"select_component_ymin\" \"select_component_ymax\" #> [19] \"text_component_ymin_manual\" \"text_component_ymax_manual\" #> [21] \"select_component_yintercept\" \"text_component_yintercept_manual\" #> [23] \"select_component_xintercept\" \"text_component_xintercept_manual\" #> [25] \"select_component_fill\" \"select_component_weight\" #> [27] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [29] \"select_component_lower\" \"select_component_middle\" #> [31] \"select_component_upper\" \"text_component_lower_manual\" #> [33] \"text_component_middle_manual\" \"text_component_upper_manual\" #> [35] \"button_fig_new\" \"button_fig_save\" #> [37] \"button_fig_del\" \"button_fig_copy\" #> [39] \"button_element_add\" \"hot_fg_elements\" #> [41] \"text_fig_key\" \"text_fig_notes\" #> [43] \"text_component_xlab\" \"text_component_ylab\" #> [45] \"text_component_xlim\" \"text_component_ylim\" #> [47] \"text_component_ggtitle\" \"select_fg_page\" #> [49] \"select_current_fig\" \"select_current_view\" #> [51] \"select_component_facet\" \"select_component_xscale\" #> [53] \"select_component_yscale\" \"select_fg_element\" #> #> $FG$isgood #> [1] FALSE #> #> $FG$DSV #> $FG$DSV$isgood #> [1] FALSE #> #> $FG$DSV$hasds #> [1] FALSE #> #> $FG$DSV$catalog #> NULL #> #> $FG$DSV$modules #> list() #> #> $FG$DSV$ds #> list() #> #> #> $FG$fig_cntr #> [1] 0 #> #> $FG$aes_elements #> [1] \"line\" \"point\" \"errorbar\" \"hguide\" \"vguide\" \"smooth\" \"ribbon\" #> [8] \"boxplot\" #> #> $FG$auto_elements #> $FG$auto_elements$line #> $FG$auto_elements$line$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$line$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$point #> $FG$auto_elements$point$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" \"select_component_color\" #> [4] \"select_component_group\" \"select_component_shape\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$point$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_shape_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$errorbar #> $FG$auto_elements$errorbar$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" \"select_component_ymax\" #> [4] \"select_component_color\" \"select_component_group\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$errorbar$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$hguide #> $FG$auto_elements$hguide$ui_aes_select_id #> [1] \"select_component_yintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$hguide$ui_aes_manual_id #> [1] \"text_component_yintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$vguide #> $FG$auto_elements$vguide$ui_aes_select_id #> [1] \"select_component_xintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$vguide$ui_aes_manual_id #> [1] \"text_component_xintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$smooth #> $FG$auto_elements$smooth$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_fill\" \"select_component_weight\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" \"select_component_ymax\" #> [11] \"select_component_ymin\" #> #> $FG$auto_elements$smooth$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" \"text_component_ymax_manual\" #> [11] \"text_component_ymin_manual\" #> #> #> $FG$auto_elements$ribbon #> $FG$auto_elements$ribbon$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" #> [3] \"select_component_ymax\" \"select_component_color\" #> [5] \"select_component_group\" \"select_component_fill\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" #> #> $FG$auto_elements$ribbon$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_fill_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$boxplot #> $FG$auto_elements$boxplot$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_lower\" \"select_component_middle\" #> [5] \"select_component_upper\" \"select_component_ymin\" #> [7] \"select_component_ymax\" \"select_component_color\" #> [9] \"select_component_group\" \"select_component_fill\" #> [11] \"select_component_weight\" \"select_component_linetype\" #> [13] \"select_component_size\" \"select_component_shape\" #> [15] \"select_component_alpha\" #> #> $FG$auto_elements$boxplot$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_lower_manual\" \"text_component_middle_manual\" #> [5] \"text_component_upper_manual\" \"text_component_ymin_manual\" #> [7] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [9] \"text_component_group_manual\" \"text_component_fill_manual\" #> [11] \"text_component_weight_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_shape_manual\" #> [15] \"text_component_alpha_manual\" #> #> #> #> #> $MOD_TYPE #> [1] \"FG\" #> #> $id #> [1] \"FG\" #> #> $dep_mod_ids #> [1] \"UD\" \"DW\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/FG.yaml\" #>"},{"path":"/reference/FG_new_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize New Figure — FG_new_fig","title":"Initialize New Figure — FG_new_fig","text":"Creates new figure FG module","code":""},{"path":"/reference/FG_new_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize New Figure — FG_new_fig","text":"","code":"FG_new_fig(state)"},{"path":"/reference/FG_new_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize New Figure — FG_new_fig","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/FG_new_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize New Figure — FG_new_fig","text":"FG state object containing new empty figure figure set current active figure","code":""},{"path":"/reference/FG_new_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize New Figure — FG_new_fig","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90 # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba"},{"path":"/reference/FG_set_current_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Current Figure — FG_set_current_fig","title":"Sets Current Figure — FG_set_current_fig","text":"Takes FG state figure list sets figure list value active figure","code":""},{"path":"/reference/FG_set_current_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Current Figure — FG_set_current_fig","text":"","code":"FG_set_current_fig(state, fig)"},{"path":"/reference/FG_set_current_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Current Figure — FG_set_current_fig","text":"state FG state FG_fetch_state() fig Figure list FG_fetch_current_fig","code":""},{"path":"/reference/FG_set_current_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Current Figure — FG_set_current_fig","text":"State current figure updated","code":""},{"path":"/reference/FG_set_current_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Current Figure — FG_set_current_fig","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:4a35c07177b3e4c3e0b476d7228e8f90 # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:e6eed59da97b5eb65da1c3a7de1202ba"},{"path":"/reference/FG_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — FG_test_mksession","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/FG_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"","code":"FG_test_mksession( session, id = \"FG\", id_UD = \"UD\", id_DW = \"DW\", full_session = TRUE )"},{"path":"/reference/FG_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements id_UD ID string corresponds ID used call UD modules UI elements id_DW ID string corresponds ID used call DW modules UI elements full_session Boolean indicate full test session created (default TRUE).","code":""},{"path":"/reference/FG_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/FG_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"","code":"sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f"},{"path":"/reference/FG_update_checksum.html","id":null,"dir":"Reference","previous_headings":"","what":"Updates FG Module Checksum — FG_update_checksum","title":"Updates FG Module Checksum — FG_update_checksum","text":"Called changes figures, function update checksum module. allows modules determine changes figures within .","code":""},{"path":"/reference/FG_update_checksum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Updates FG Module Checksum — FG_update_checksum","text":"","code":"FG_update_checksum(state)"},{"path":"/reference/FG_update_checksum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Updates FG Module Checksum — FG_update_checksum","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/FG_update_checksum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Updates FG Module Checksum — FG_update_checksum","text":"state checksum updated.","code":""},{"path":"/reference/FG_update_checksum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Updates FG Module Checksum — FG_update_checksum","text":"","code":"# This will create a populated FG state object: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f state = sess_res$state state = FG_update_checksum(state) #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f"},{"path":"/reference/FM_add_ui_tooltip.html","id":null,"dir":"Reference","previous_headings":"","what":"Add Tooltip to UI Element — FM_add_ui_tooltip","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"Adds tool tip user element.","code":""},{"path":"/reference/FM_add_ui_tooltip.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"","code":"FM_add_ui_tooltip( state, uiele, tooltip = \"mytooltip\", position = \"right\", size = \"medium\" )"},{"path":"/reference/FM_add_ui_tooltip.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"state Current module state yaml file read. uiele UI element add toooltip . tooltip Text containing tool tip. position Position tooltip. size size tooltip","code":""},{"path":"/reference/FM_add_ui_tooltip.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"tooltips enabled suggested packages installed uiele tooltip added returned. Otherwise just return original uiele unchanged.","code":""},{"path":"/reference/FM_add_ui_tooltip.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"","code":"if(interactive()){ # We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) state = sess_res$state uiele = shiny::textInput(inputId = \"my input\", label=\"example input\") uiele = FM_add_ui_tooltip(state, uiele) }"},{"path":"/reference/FM_build_comment.html","id":null,"dir":"Reference","previous_headings":"","what":"Create RStudio Formatted Comments — FM_build_comment","title":"Create RStudio Formatted Comments — FM_build_comment","text":"Takes character string builds comment formatted section specified level RStudio","code":""},{"path":"/reference/FM_build_comment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create RStudio Formatted Comments — FM_build_comment","text":"","code":"FM_build_comment(level = 1, comment_str)"},{"path":"/reference/FM_build_comment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create RStudio Formatted Comments — FM_build_comment","text":"level Integer (1 (default),2, 3) indicating section level comment. comment_str Character object.","code":""},{"path":"/reference/FM_build_comment.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create RStudio Formatted Comments — FM_build_comment","text":"Formatted comment.","code":""},{"path":"/reference/FM_build_comment.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create RStudio Formatted Comments — FM_build_comment","text":"","code":"FM_build_comment(1, \"This is a level 1 header\") #> [1] \"# This is a level 1 header ------------------------------------------------\" FM_build_comment(2, paste0(rep(\"Long string repeated.\", 5), collapse=\" \")) #> [1] \"# Long string repeated. Long string repeated. Long string repeated. L =====\""},{"path":"/reference/FM_fetch_app_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"Takes current state app builds script reproduce analysis within app.","code":""},{"path":"/reference/FM_fetch_app_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"","code":"FM_fetch_app_code(session, state, mod_ids)"},{"path":"/reference/FM_fetch_app_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"session Shiny session variable state module state yaml read mod_ids Vector module IDs order needed (used code generation).","code":""},{"path":"/reference/FM_fetch_app_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"list following elements: isgood: Boolean indicating whether code generation successful (TRUE) msgs: messages generated code: Code regenerate app","code":""},{"path":"/reference/FM_fetch_app_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"","code":"# We need a Shiny session object to use this function: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session state = sess_res$state app_code = FM_fetch_app_code(session = session, state = state, mod_ids = c(\"UD\", \"DW\")) cat(app_code$code) #> # formods automated output ------------------------------------------------ #> # https://formods.ubiquity.tools/ #> rm(list=ls()) #> library(\"dplyr\") #> library(\"janitor\") #> library(\"readr\") #> library(\"readxl\") #> library(\"tidyr\") #> #> #> # This reporting object has the formatting #> # information for table generation #> rpt = onbrand::read_template( #> template = file.path(\"config\", \"report.docx\"), #> mapping = file.path(\"config\", \"report.yaml\")) #> #> # Loading data ------------------------------------------------------------ #> myDS = readxl::read_excel(path=\"TEST_DATA.xlsx\", sheet=\"DATA\") #> myDS = janitor::clean_names(myDS, case=\"none\") #> #> # Data wrangling ---------------------------------------------------------- #> # Observations ============================================================ #> DW_myDS_1 = myDS #> DW_myDS_1 = dplyr::filter(DW_myDS_1,EVID == 0) #> DW_myDS_1 = dplyr::filter(DW_myDS_1,DV != 0) #> DW_myDS_1 = dplyr::mutate(DW_myDS_1,IDCMT = paste0(ID, ', ', CMT)) #> #> # PK 3mg SD IV ============================================================ #> DW_myDS_2 = myDS #> DW_myDS_2 = dplyr::filter(DW_myDS_2,EVID == 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,DV != 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg MD SC (first dose) =============================================== #> DW_myDS_3 = myDS #> DW_myDS_3 = dplyr::filter(DW_myDS_3,EVID == 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DV != 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DOSE_NUM == 1) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,CMT %in% c(\"C_ng_ml\")) #> #> # Parameters ============================================================== #> DW_myDS_4 = myDS #> DW_myDS_4 = dplyr::group_by(DW_myDS_4,ID) #> DW_myDS_4 = dplyr::filter(DW_myDS_4,row_number()==1) #> DW_myDS_4 = dplyr::select(DW_myDS_4,ID, DOSE, DOSE_STR, Cohort, ROUTE, ka, CL, Vc, Vp, Q) #> DW_myDS_4 = tidyr::pivot_longer(DW_myDS_4, cols = c(\"ka\", \"CL\", \"Vc\", \"Vp\", \"Q\"), names_to = \"parameter\", values_to = \"values\") #> #> # PK/PD 3mg SD IV w/BQL =================================================== #> DW_myDS_5 = myDS #> DW_myDS_5 = dplyr::filter(DW_myDS_5,EVID == 0) #> DW_myDS_5 = dplyr::filter(DW_myDS_5,Cohort %in% c(\"SD 3 mg IV\")) #> #> # PK/PD 3mg MD SC (first dose) w/BQL ====================================== #> DW_myDS_6 = myDS #> DW_myDS_6 = dplyr::filter(DW_myDS_6,EVID == 0) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,DOSE_NUM == 1) #> #> # PK 3mg SD IV w/BQL ====================================================== #> DW_myDS_7 = myDS #> DW_myDS_7 = dplyr::filter(DW_myDS_7,EVID == 0) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg SD IV w/BQL w/dosing ============================================= #> DW_myDS_8 = myDS #> DW_myDS_8 = dplyr::filter(DW_myDS_8,Cohort %in% c(\"MD 3 mg IV\")) #>"},{"path":"/reference/FM_fetch_app_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Informaiton About the App — FM_fetch_app_info","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"Returns diagnostic information app","code":""},{"path":"/reference/FM_fetch_app_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"","code":"FM_fetch_app_info(session)"},{"path":"/reference/FM_fetch_app_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"session Shiny session variable.","code":""},{"path":"/reference/FM_fetch_app_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"List information app following structure uiele: system information UI elements used shiny apps. uiele_packages: UI element installed packages used shiny apps. uiele_options: UI element current options. uiele_modules: UI element loaded formods modules used shiny apps. msgs: System information text used report/terminal. si_packages Dataframe currently used packages. si_options Dataframe current options","code":""},{"path":"/reference/FM_fetch_app_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session app_info = FM_fetch_app_info(session) app_info$msgs #> [1] \"Modules\" #> [2] \"ID: UD\" #> [3] \"type: UD\" #> [4] \"FM_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> [5] \"MOD_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml\" #> [6] \"User files: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM\" #> [7] \"Log file: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/formods_log.txt\" #> [8] \"Package dependencies: janitor, readr, readxl\" #> [9] \" package * version date (UTC) lib source\" #> [10] \" abind 1.4-5 2016-07-21 [2] CRAN (R 4.2.0)\" #> [11] \" askpass 1.1 2019-01-13 [2] CRAN (R 4.2.0)\" #> [12] \" backports 1.4.1 2021-12-13 [2] CRAN (R 4.2.0)\" #> [13] \" broom 1.0.4 2023-03-11 [2] CRAN (R 4.2.0)\" #> [14] \" bslib 0.4.2 2022-12-16 [2] CRAN (R 4.2.0)\" #> [15] \" cachem 1.0.7 2023-02-24 [2] CRAN (R 4.2.0)\" #> [16] \" callr 3.7.3 2022-11-02 [2] CRAN (R 4.2.0)\" #> [17] \" car 3.1-2 2023-03-30 [2] CRAN (R 4.2.1)\" #> [18] \" carData 3.0-5 2022-01-06 [2] CRAN (R 4.2.0)\" #> [19] \" cellranger 1.1.0 2016-07-27 [2] CRAN (R 4.2.0)\" #> [20] \" cli 3.6.1 2023-03-23 [2] CRAN (R 4.2.0)\" #> [21] \" clipr 0.8.0 2022-02-22 [2] CRAN (R 4.2.0)\" #> [22] \" colorspace 2.1-0 2023-01-23 [2] CRAN (R 4.2.0)\" #> [23] \" crayon 1.5.2 2022-09-29 [2] CRAN (R 4.2.0)\" #> [24] \" crul 1.3 2022-09-03 [2] CRAN (R 4.2.0)\" #> [25] \" curl 5.0.0 2023-01-12 [2] CRAN (R 4.2.0)\" #> [26] \" data.table 1.14.8 2023-02-17 [2] CRAN (R 4.2.0)\" #> [27] \" desc 1.4.2 2022-09-08 [2] CRAN (R 4.2.0)\" #> [28] \" devtools 2.4.5 2022-10-11 [2] CRAN (R 4.2.0)\" #> [29] \" digest 0.6.31 2022-12-11 [2] CRAN (R 4.2.0)\" #> [30] \" downlit 0.4.2 2022-07-05 [2] CRAN (R 4.2.0)\" #> [31] \" dplyr 1.1.1 2023-03-22 [2] CRAN (R 4.2.0)\" #> [32] \" ellipsis 0.3.2 2021-04-29 [2] CRAN (R 4.2.0)\" #> [33] \" evaluate 0.20 2023-01-17 [2] CRAN (R 4.2.0)\" #> [34] \" fansi 1.0.4 2023-01-22 [2] CRAN (R 4.2.0)\" #> [35] \" farver 2.1.1 2022-07-06 [2] CRAN (R 4.2.0)\" #> [36] \" fastmap 1.1.1 2023-02-24 [2] CRAN (R 4.2.0)\" #> [37] \" flextable 0.9.1 2023-04-02 [2] CRAN (R 4.2.1)\" #> [38] \" fontBitstreamVera 0.1.1 2017-02-01 [2] CRAN (R 4.2.0)\" #> [39] \" fontLiberation 0.1.0 2016-10-15 [2] CRAN (R 4.2.0)\" #> [40] \" fontquiver 0.2.1 2017-02-01 [2] CRAN (R 4.2.0)\" #> [41] \" formods * 0.1.2 2023-11-21 [1] local\" #> [42] \" fs 1.6.1 2023-02-06 [2] CRAN (R 4.2.0)\" #> [43] \" gdtools 0.3.3 2023-03-27 [2] CRAN (R 4.2.1)\" #> [44] \" generics 0.1.3 2022-07-05 [2] CRAN (R 4.2.0)\" #> [45] \" gfonts 0.2.0 2023-01-08 [2] CRAN (R 4.2.0)\" #> [46] \" ggforce 0.4.1 2022-10-04 [2] CRAN (R 4.2.0)\" #> [47] \" ggplot2 3.4.2 2023-04-03 [2] CRAN (R 4.2.0)\" #> [48] \" ggpubr 0.6.0 2023-02-10 [2] CRAN (R 4.2.0)\" #> [49] \" ggsignif 0.6.4 2022-10-13 [2] CRAN (R 4.2.0)\" #> [50] \" glue 1.6.2 2022-02-24 [2] CRAN (R 4.2.0)\" #> [51] \" gtable 0.3.3 2023-03-21 [2] CRAN (R 4.2.0)\" #> [52] \" hms 1.1.3 2023-03-21 [2] CRAN (R 4.2.0)\" #> [53] \" htmltools 0.5.5 2023-03-23 [2] CRAN (R 4.2.0)\" #> [54] \" htmlwidgets 1.6.2 2023-03-17 [2] CRAN (R 4.2.0)\" #> [55] \" httpcode 0.3.0 2020-04-10 [2] CRAN (R 4.2.0)\" #> [56] \" httpuv 1.6.9 2023-02-14 [2] CRAN (R 4.2.0)\" #> [57] \" httr 1.4.5 2023-02-24 [2] CRAN (R 4.2.0)\" #> [58] \" janitor 2.2.0 2023-02-02 [2] CRAN (R 4.2.0)\" #> [59] \" jquerylib 0.1.4 2021-04-26 [2] CRAN (R 4.2.0)\" #> [60] \" jsonlite 1.8.4 2022-12-06 [2] CRAN (R 4.2.0)\" #> [61] \" knitr 1.42 2023-01-25 [2] CRAN (R 4.2.0)\" #> [62] \" labeling 0.4.2 2020-10-20 [2] CRAN (R 4.2.0)\" #> [63] \" later 1.3.0 2021-08-18 [2] CRAN (R 4.2.0)\" #> [64] \" lazyeval 0.2.2 2019-03-15 [2] CRAN (R 4.2.0)\" #> [65] \" lifecycle 1.0.3 2022-10-07 [2] CRAN (R 4.2.0)\" #> [66] \" lubridate 1.9.2 2023-02-10 [2] CRAN (R 4.2.0)\" #> [67] \" magrittr 2.0.3 2022-03-30 [2] CRAN (R 4.2.0)\" #> [68] \" MASS 7.3-58.2 2023-01-23 [2] CRAN (R 4.2.0)\" #> [69] \" memoise 2.0.1 2021-11-26 [2] CRAN (R 4.2.0)\" #> [70] \" mime 0.12 2021-09-28 [2] CRAN (R 4.2.0)\" #> [71] \" miniUI 0.1.1.1 2018-05-18 [2] CRAN (R 4.2.0)\" #> [72] \" munsell 0.5.0 2018-06-12 [2] CRAN (R 4.2.0)\" #> [73] \" officer 0.6.2 2023-03-28 [2] CRAN (R 4.2.1)\" #> [74] \" onbrand 1.0.3 2023-07-16 [2] CRAN (R 4.2.0)\" #> [75] \" openssl 2.0.6 2023-03-09 [2] CRAN (R 4.2.0)\" #> [76] \" pillar 1.9.0 2023-03-22 [2] CRAN (R 4.2.0)\" #> [77] \" pkgbuild 1.4.0 2022-11-27 [2] CRAN (R 4.2.0)\" #> [78] \" pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.2.0)\" #> [79] \" pkgdown 2.0.7 2022-12-14 [2] CRAN (R 4.2.0)\" #> [80] \" pkgload 1.3.2 2022-11-16 [2] CRAN (R 4.2.0)\" #> [81] \" plotly 4.10.1 2022-11-07 [2] CRAN (R 4.2.0)\" #> [82] \" polyclip 1.10-4 2022-10-20 [2] CRAN (R 4.2.1)\" #> [83] \" prettyunits 1.1.1 2020-01-24 [2] CRAN (R 4.2.0)\" #> [84] \" processx 3.8.0 2022-10-26 [2] CRAN (R 4.2.0)\" #> [85] \" profvis 0.3.7 2020-11-02 [2] CRAN (R 4.2.0)\" #> [86] \" promises 1.2.0.1 2021-02-11 [2] CRAN (R 4.2.0)\" #> [87] \" prompter 1.1.0 2021-10-07 [2] CRAN (R 4.2.0)\" #> [88] \" ps 1.7.4 2023-04-02 [2] CRAN (R 4.2.1)\" #> [89] \" purrr 1.0.1 2023-01-10 [2] CRAN (R 4.2.0)\" #> [90] \" R6 2.5.1 2021-08-19 [2] CRAN (R 4.2.0)\" #> [91] \" ragg 1.2.5 2023-01-12 [2] CRAN (R 4.2.0)\" #> [92] \" Rcpp 1.0.10 2023-01-22 [2] CRAN (R 4.2.0)\" #> [93] \" readr 2.1.4 2023-02-10 [2] CRAN (R 4.2.0)\" #> [94] \" readxl 1.4.2 2023-02-09 [2] CRAN (R 4.2.0)\" #> [95] \" remotes 2.4.2 2021-11-30 [2] CRAN (R 4.2.0)\" #> [96] \" rhandsontable 0.3.8 2021-05-27 [2] CRAN (R 4.2.0)\" #> [97] \" rlang 1.1.0 2023-03-14 [2] CRAN (R 4.2.0)\" #> [98] \" rmarkdown 2.21 2023-03-26 [2] CRAN (R 4.2.1)\" #> [99] \" rprojroot 2.0.3 2022-04-02 [2] CRAN (R 4.2.0)\" #> [100] \" rstatix 0.7.2 2023-02-01 [2] CRAN (R 4.2.0)\" #> [101] \" rstudioapi 0.14 2022-08-22 [2] CRAN (R 4.2.0)\" #> [102] \" sass 0.4.5 2023-01-24 [2] CRAN (R 4.2.0)\" #> [103] \" scales 1.2.1 2022-08-20 [2] CRAN (R 4.2.0)\" #> [104] \" sessioninfo 1.2.2 2021-12-06 [2] CRAN (R 4.2.0)\" #> [105] \" shiny 1.7.4 2022-12-15 [2] CRAN (R 4.2.0)\" #> [106] \" shinyAce 0.4.2 2022-05-06 [2] CRAN (R 4.2.0)\" #> [107] \" shinybusy 0.3.1 2022-05-10 [2] CRAN (R 4.2.0)\" #> [108] \" shinydashboard 0.7.2 2021-09-30 [2] CRAN (R 4.2.0)\" #> [109] \" shinyWidgets 0.8.0 2023-08-30 [2] CRAN (R 4.2.0)\" #> [110] \" snakecase 0.11.0 2019-05-25 [2] CRAN (R 4.2.0)\" #> [111] \" stringi 1.7.12 2023-01-11 [2] CRAN (R 4.2.0)\" #> [112] \" stringr 1.5.0 2022-12-02 [2] CRAN (R 4.2.0)\" #> [113] \" systemfonts 1.0.4 2022-02-11 [2] CRAN (R 4.2.0)\" #> [114] \" textshaping 0.3.6 2021-10-13 [2] CRAN (R 4.2.0)\" #> [115] \" tibble 3.2.1 2023-03-20 [2] CRAN (R 4.2.0)\" #> [116] \" tidyr 1.3.0 2023-01-24 [2] CRAN (R 4.2.0)\" #> [117] \" tidyselect 1.2.0 2022-10-10 [2] CRAN (R 4.2.0)\" #> [118] \" timechange 0.2.0 2023-01-11 [2] CRAN (R 4.2.0)\" #> [119] \" tweenr 2.0.2 2022-09-06 [2] CRAN (R 4.2.0)\" #> [120] \" tzdb 0.3.0 2022-03-28 [2] CRAN (R 4.2.0)\" #> [121] \" urlchecker 1.0.1 2021-11-30 [2] CRAN (R 4.2.0)\" #> [122] \" usethis 2.1.6 2022-05-25 [2] CRAN (R 4.2.0)\" #> [123] \" utf8 1.2.3 2023-01-31 [2] CRAN (R 4.2.0)\" #> [124] \" uuid 1.1-0 2022-04-19 [2] CRAN (R 4.2.0)\" #> [125] \" vctrs 0.6.1 2023-03-22 [2] CRAN (R 4.2.0)\" #> [126] \" viridisLite 0.4.1 2022-08-22 [2] CRAN (R 4.2.0)\" #> [127] \" whisker 0.4.1 2022-12-05 [2] CRAN (R 4.2.0)\" #> [128] \" withr 2.5.0 2022-03-03 [2] CRAN (R 4.2.0)\" #> [129] \" writexl 1.4.2 2023-01-06 [2] CRAN (R 4.2.0)\" #> [130] \" xfun 0.38 2023-03-24 [2] CRAN (R 4.2.0)\" #> [131] \" xml2 1.3.3 2021-11-30 [2] CRAN (R 4.2.0)\" #> [132] \" xtable 1.8-4 2019-04-21 [2] CRAN (R 4.2.0)\" #> [133] \" yaml 2.3.7 2023-01-23 [2] CRAN (R 4.2.0)\" #> [134] \" zip 2.2.2 2022-10-26 [2] CRAN (R 4.2.0)\" #> [135] \"\" #> [136] \" [1] /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2\" #> [137] \" [2] /Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/library\""},{"path":"/reference/FM_fetch_app_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the App State — FM_fetch_app_state","title":"Fetches the App State — FM_fetch_app_state","text":"Returns entire state App","code":""},{"path":"/reference/FM_fetch_app_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the App State — FM_fetch_app_state","text":"","code":"FM_fetch_app_state(session)"},{"path":"/reference/FM_fetch_app_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the App State — FM_fetch_app_state","text":"session Shiny session variable.","code":""},{"path":"/reference/FM_fetch_app_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the App State — FM_fetch_app_state","text":"App state NULL defined.","code":""},{"path":"/reference/FM_fetch_app_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the App State — FM_fetch_app_state","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session app_state = FM_fetch_app_state(session) app_state #> $FM_UD #> $FM_UD$yaml #> $FM_UD$yaml$FM #> $FM_UD$yaml$FM$include #> $FM_UD$yaml$FM$include$files #> $FM_UD$yaml$FM$include$files[[1]] #> $FM_UD$yaml$FM$include$files[[1]]$file #> $FM_UD$yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $FM_UD$yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $FM_UD$yaml$FM$include$files[[2]] #> $FM_UD$yaml$FM$include$files[[2]]$file #> $FM_UD$yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $FM_UD$yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $FM_UD$yaml$FM$include$files[[3]] #> $FM_UD$yaml$FM$include$files[[3]]$file #> $FM_UD$yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $FM_UD$yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $FM_UD$yaml$FM$deployed #> [1] FALSE #> #> $FM_UD$yaml$FM$code #> $FM_UD$yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $FM_UD$yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $FM_UD$yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $FM_UD$yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $FM_UD$yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $FM_UD$yaml$FM$notifications #> $FM_UD$yaml$FM$notifications$config #> $FM_UD$yaml$FM$notifications$config$success #> $FM_UD$yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $FM_UD$yaml$FM$notifications$config$failure #> $FM_UD$yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $FM_UD$yaml$FM$notifications$config$info #> $FM_UD$yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $FM_UD$yaml$FM$notifications$config$warning #> $FM_UD$yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $FM_UD$yaml$FM$reporting #> $FM_UD$yaml$FM$reporting$enabled #> [1] TRUE #> #> $FM_UD$yaml$FM$reporting$content_init #> $FM_UD$yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $FM_UD$yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $FM_UD$yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $FM_UD$yaml$FM$ui #> $FM_UD$yaml$FM$ui$button_style #> [1] \"fill\" #> #> $FM_UD$yaml$FM$ui$select_size #> [1] 10 #> #> $FM_UD$yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $FM_UD$yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $FM_UD$yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $FM_UD$yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $FM_UD$yaml$FM$data_meta #> $FM_UD$yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $FM_UD$yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $FM_UD$yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $FM_UD$yaml$FM$data_meta$data_types #> $FM_UD$yaml$FM$data_meta$data_types$character #> $FM_UD$yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $FM_UD$yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $FM_UD$yaml$FM$data_meta$data_types$double #> $FM_UD$yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $FM_UD$yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $FM_UD$yaml$FM$data_meta$data_types$integer #> $FM_UD$yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $FM_UD$yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $FM_UD$yaml$FM$data_meta$data_types$other #> $FM_UD$yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $FM_UD$yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $FM_UD$yaml$FM$labels #> $FM_UD$yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $FM_UD$yaml$FM$user_files #> $FM_UD$yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $FM_UD$yaml$FM$logging #> $FM_UD$yaml$FM$logging$enabled #> [1] TRUE #> #> $FM_UD$yaml$FM$logging$timestamp #> [1] TRUE #> #> $FM_UD$yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $FM_UD$yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $FM_UD$yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $FM_UD$MC #> $FM_UD$MC$compact #> $FM_UD$MC$compact$code #> [1] FALSE #> #> $FM_UD$MC$compact$preview #> [1] TRUE #> #> #> $FM_UD$MC$reporting #> $FM_UD$MC$reporting$enabled #> [1] FALSE #> #> $FM_UD$MC$reporting$priority #> [1] 1 #> #> #> $FM_UD$MC$labels #> $FM_UD$MC$labels$default_ds #> [1] \"Original data set\" #> #> $FM_UD$MC$labels$upload_button #> [1] \"Select file\" #> #> $FM_UD$MC$labels$tab_main #> [1] \"Upload file\" #> #> $FM_UD$MC$labels$tab_code #> [1] \"Code\" #> #> $FM_UD$MC$labels$tab_preview #> [1] \"Data preview\" #> #> $FM_UD$MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $FM_UD$MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $FM_UD$MC$tooltips #> $FM_UD$MC$tooltips$include #> [1] TRUE #> #> $FM_UD$MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $FM_UD$MC$formatting #> $FM_UD$MC$formatting$preview #> $FM_UD$MC$formatting$preview$width #> [1] 800 #> #> $FM_UD$MC$formatting$preview$height #> [1] 500 #> #> #> $FM_UD$MC$formatting$code #> $FM_UD$MC$formatting$code$width #> [1] 500 #> #> $FM_UD$MC$formatting$code$height #> [1] 200 #> #> #> $FM_UD$MC$formatting$switch_clean #> $FM_UD$MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $FM_UD$MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $FM_UD$MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $FM_UD$MC$code #> $FM_UD$MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $FM_UD$MC$code$readOnly #> [1] TRUE #> #> $FM_UD$MC$code$mode #> [1] \"r\" #> #> $FM_UD$MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $FM_UD$MC$ds_object_name #> [1] \"myDS\" #> #> $FM_UD$MC$clean_data #> $FM_UD$MC$clean_data$enabled #> [1] TRUE #> #> $FM_UD$MC$clean_data$default #> [1] TRUE #> #> $FM_UD$MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $FM_UD$UD #> $FM_UD$UD$isgood #> [1] TRUE #> #> $FM_UD$UD$clean #> [1] TRUE #> #> $FM_UD$UD$load_msg #> <em>File loaded.<\/em> #> #> $FM_UD$UD$data_file_local #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/TEST_DATA.xlsx\" #> #> $FM_UD$UD$data_file_ext #> [1] \"xlsx\" #> #> $FM_UD$UD$data_file #> [1] \"TEST_DATA.xlsx\" #> #> $FM_UD$UD$sheet #> NULL #> #> $FM_UD$UD$sheets #> [1] \"DATA\" \"DDT\" #> #> $FM_UD$UD$code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $FM_UD$UD$object_name #> [1] \"myDS\" #> #> $FM_UD$UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $FM_UD$UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> #> $FM_UD$MOD_TYPE #> [1] \"UD\" #> #> $FM_UD$id #> [1] \"UD\" #> #> $FM_UD$FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $FM_UD$MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml\" #> #>"},{"path":"/reference/FM_fetch_current_mods.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Details About Current Modules — FM_fetch_current_mods","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"Use get information currently supported modules. includes short names, UI elements,","code":""},{"path":"/reference/FM_fetch_current_mods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"","code":"FM_fetch_current_mods()"},{"path":"/reference/FM_fetch_current_mods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"list details currently supported modules.","code":""},{"path":"/reference/FM_fetch_current_mods.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"","code":"FM_fetch_current_mods() #> $mods #> $mods$ASM #> $mods$ASM$Name #> [1] \"App State Mangement\" #> #> $mods$ASM$Short_Name #> [1] \"ASM\" #> #> $mods$ASM$UI #> $mods$ASM$UI$htmlOutput #> [1] \"ui_asm_save_name\" \"ui_asm_save_button\" \"ui_asm_load_state\" #> #> $mods$ASM$UI$other #> [1] \"ui_asm_msg\" \"ui_asm_ace_code\" #> #> #> #> $mods$UD #> $mods$UD$Name #> [1] \"Upload Data\" #> #> $mods$UD$Short_Name #> [1] \"UD\" #> #> $mods$UD$UI #> $mods$UD$UI$htmlOutput #> [1] \"ui_ud_load_data\" \"ui_ud_select_sheets\" \"ui_ud_text_load_result\" #> [4] \"ui_ud_data_preview\" #> #> $mods$UD$UI$other #> [1] \"ui_ud_ace_code\" #> #> #> #> $mods$DW #> $mods$DW$Name #> [1] \"Data Wrangling\" #> #> $mods$DW$Short_Name #> [1] \"DW\" #> #> $mods$DW$UI #> $mods$DW$UI$htmlOutput #> [1] \"ui_dw_views\" \"ui_dw_key\" #> [3] \"ui_dw_new_view\" \"ui_dw_save_view\" #> [5] \"ui_dw_del_view\" \"ui_dw_copy_view\" #> [7] \"ui_dw_add_element_button\" \"ui_dw_select\" #> [9] \"ui_dw_new_element_row\" #> #> $mods$DW$UI$other #> [1] \"hot_dw_elements\" \"hot_data_preview\" \"ui_dw_msg\" \"ui_dw_code\" #> #> #> #> $mods$FG #> $mods$FG$Name #> [1] \"Figure Generation\" #> #> $mods$FG$Short_Name #> [1] \"FG\" #> #> $mods$FG$UI #> $mods$FG$UI$htmlOutput #> [1] \"ui_fg_curr_views\" \"ui_fg_curr_figs\" #> [3] \"ui_fg_new_fig\" \"ui_fg_save_fig\" #> [5] \"ui_fg_del_fig\" \"ui_fg_copy_fig\" #> [7] \"ui_fg_fig_name\" \"ui_fg_fig_notes\" #> [9] \"ui_fg_add_element_button\" \"ui_fg_select\" #> [11] \"ui_fg_new_element_row\" \"ui_fg_msg\" #> [13] \"ui_fg_slider_page\" #> #> $mods$FG$UI$other #> [1] \"hot_fg_elements\" \"ui_fg_preview_ggplot\" \"ui_fg_msg\" #> [4] \"ui_fg_code\" #> #> #> #> #> $df #> Module SN #> 1 App State Mangement ASM #> 2 Upload Data UD #> 3 Data Wrangling DW #> 4 Figure Generation FG #> htmlOutput #> 1 ui_asm_save_name, ui_asm_save_button, ui_asm_load_state #> 2 ui_ud_load_data, ui_ud_select_sheets, ui_ud_text_load_result, ui_ud_data_preview #> 3 ui_dw_views, ui_dw_key, ui_dw_new_view, ui_dw_save_view, ui_dw_del_view, ui_dw_copy_view, ui_dw_add_element_button, ui_dw_select, ui_dw_new_element_row #> 4 ui_fg_curr_views, ui_fg_curr_figs, ui_fg_new_fig, ui_fg_save_fig, ui_fg_del_fig, ui_fg_copy_fig, ui_fg_fig_name, ui_fg_fig_notes, ui_fg_add_element_button, ui_fg_select, ui_fg_new_element_row, ui_fg_msg, ui_fg_slider_page #> otherOutput #> 1 ui_asm_msg, ui_asm_ace_code #> 2 ui_ud_ace_code #> 3 hot_dw_elements, hot_data_preview, ui_dw_msg, ui_dw_code #> 4 hot_fg_elements, ui_fg_preview_ggplot, ui_fg_msg, ui_fg_code #>"},{"path":"/reference/FM_fetch_data_format.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates Formatting Information for Datasets — FM_fetch_data_format","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"Takes data frame information site configureation produce formatting information make easier user see data type information.","code":""},{"path":"/reference/FM_fetch_data_format.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"","code":"FM_fetch_data_format(df, state)"},{"path":"/reference/FM_fetch_data_format.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"df Raw dataframe built rhandsontable. state Current module state yaml file read.","code":""},{"path":"/reference/FM_fetch_data_format.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"list following elements: col_heads: List (element column) formatting information column headers use rhandsontable. col_subtext: List (element column) subtext displayed selections using `pickerInput` `shinyWidgets` package.","code":""},{"path":"/reference/FM_fetch_data_format.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"","code":"# We need a module state object to use this function: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") sheet = \"DATA\" df = readxl::read_excel(path=data_file_local, sheet=sheet) hfmt = FM_fetch_data_format(df, state) # Column header formatting head(as.vector(unlist( hfmt[[\"col_heads\"]]))) #> [1] \"<span style='color:#3C8DBC'><b>ID<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [2] \"<span style='color:#3C8DBC'><b>TIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [3] \"<span style='color:#3C8DBC'><b>TIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [4] \"<span style='color:#3C8DBC'><b>NTIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [5] \"<span style='color:#3C8DBC'><b>NTIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [6] \"<span style='color:#3C8DBC'><b>TIME<\/b><br/><font size='-3'>num<\/font><\/span>\" # Column select subtext head(as.vector(unlist( hfmt[[\"col_subtext\"]]))) #> [1] \"num: 1,⋅⋅⋅,360\" \"num: 0,⋅⋅⋅,84\" \"num: 0,⋅⋅⋅,2016\" \"num: 0,⋅⋅⋅,42\" #> [5] \"num: 0,⋅⋅⋅,1008\" \"num: 0,⋅⋅⋅,2016\""},{"path":"/reference/FM_fetch_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Dependency Information — FM_fetch_deps","title":"Fetches Dependency Information — FM_fetch_deps","text":"given state session function determine module ids dependent well packages module elements might depend .","code":""},{"path":"/reference/FM_fetch_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Dependency Information — FM_fetch_deps","text":"","code":"FM_fetch_deps(state, session)"},{"path":"/reference/FM_fetch_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Dependency Information — FM_fetch_deps","text":"state Current module state yaml file read session Shiny session variable","code":""},{"path":"/reference/FM_fetch_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Dependency Information — FM_fetch_deps","text":"list following elements: mod_ids Dependent module ids. packages List package dependencies. package_code Library commands load packages.","code":""},{"path":"/reference/FM_fetch_deps.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Dependency Information — FM_fetch_deps","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state mod_deps = FM_fetch_deps(state, session)"},{"path":"/reference/FM_fetch_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Datasets from Modules in the App — FM_fetch_ds","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"Loops specified module ID modules ID specified. ID, attempt made extract datasets available.","code":""},{"path":"/reference/FM_fetch_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"","code":"FM_fetch_ds(state, session, ids = NULL)"},{"path":"/reference/FM_fetch_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"state Current module state yaml file read session Shiny session variable ids Vector ID strings modules containing datasets NULL datasets available.","code":""},{"path":"/reference/FM_fetch_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"list containing current dataset following format: isgood: Boolean indicating whether dataset found (FALSE) ds: List datasets element names corresponding R object name dataset. following format label: Text label dataset (used display user) DS: Data frame dataset DSMETA: Data frame metadata colunns dataset DS. data frame following columns: col1: column 1 code: Code generate dataset. checksum: Module checksum dataset pulled DSchecksum: Checksum dataframe DS catalog: Dataframe containing tabular catalog datasets found. label: Text label object: Name R Object containing data frame MOD_TYPE: Short name type module id: Module ID checksum: Module checksum DSchecksum: Checksum dataset code: Code generate dataset modules: List entry module. element name short name. list entry shiny module ID. checksum. example access checksum DW module module ID 'my_id', use following: res$modules$DW$my_id.","code":""},{"path":"/reference/FM_fetch_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"","code":"# We need a module state and a Shiny session variable # to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state ds = FM_fetch_ds(state, session) ds$catalog #> label object MOD_TYPE id checksum #> 1 Original data set myDS UD UD 897d952fecbc804999396a96f9df4b20 #> DSchecksum #> 1 897d952fecbc804999396a96f9df4b20 #> code #> 1 myDS = readxl::read_excel(path=\"TEST_DATA.xlsx\", sheet=\"DATA\")\\nmyDS = janitor::clean_names(myDS, case=\"none\")"},{"path":"/reference/FM_fetch_log_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Path to the Log File — FM_fetch_log_path","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"Use get path formods log file","code":""},{"path":"/reference/FM_fetch_log_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"","code":"FM_fetch_log_path(state)"},{"path":"/reference/FM_fetch_log_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"state module state yaml read","code":""},{"path":"/reference/FM_fetch_log_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"Character string path log file.","code":""},{"path":"/reference/FM_fetch_log_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"","code":"# Within shiny a session variable will exist, # this creates one here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session # This function assumes that some module state exists: state = UD_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), id = \"UD\", session = session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized FM_fetch_log_path(state) #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/formods_log.txt\""},{"path":"/reference/FM_fetch_mdl.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Models from Modules in the App — FM_fetch_mdl","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"Loops specified module ID modules ID specified. ID, attempt made extract models available.","code":""},{"path":"/reference/FM_fetch_mdl.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"","code":"FM_fetch_mdl(state, session, ids = NULL)"},{"path":"/reference/FM_fetch_mdl.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"state Current module state yaml file read session Shiny session variable ids Vector ID strings modules containing models NULL modules models available.","code":""},{"path":"/reference/FM_fetch_mdl.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"list containing current dataset following format: JMH isgood: Boolean indicating whether dataset found (FALSE) catalog: Dataframe containing tabular catalog models found. label: Text label modules: List entry module..","code":""},{"path":"/reference/FM_fetch_mdl.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"","code":"# We need a module state and a Shiny session variable # to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state mdl = FM_fetch_mdl(state, session) mdl$catalog #> NULL"},{"path":"/reference/FM_fetch_mod_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch the Module State — FM_fetch_mod_state","title":"Fetch the Module State — FM_fetch_mod_state","text":"Fetches module state userdata specified id","code":""},{"path":"/reference/FM_fetch_mod_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch the Module State — FM_fetch_mod_state","text":"","code":"FM_fetch_mod_state(session, id)"},{"path":"/reference/FM_fetch_mod_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch the Module State — FM_fetch_mod_state","text":"session Shiny session variable. id ID string module.","code":""},{"path":"/reference/FM_fetch_mod_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch the Module State — FM_fetch_mod_state","text":"module state NULL defined.","code":""},{"path":"/reference/FM_fetch_mod_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch the Module State — FM_fetch_mod_state","text":"","code":"# We need a Shiny session variable to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = FM_fetch_mod_state(session, id)"},{"path":"/reference/FM_fetch_user_files_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Path to the User Files — FM_fetch_user_files_path","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"Use get path temporary directory formods stores user files.","code":""},{"path":"/reference/FM_fetch_user_files_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"","code":"FM_fetch_user_files_path(state)"},{"path":"/reference/FM_fetch_user_files_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"state module state yaml read","code":""},{"path":"/reference/FM_fetch_user_files_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"Character string path log file.","code":""},{"path":"/reference/FM_fetch_user_files_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"","code":"# We need a state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state user_dir = FM_fetch_user_files_path(state) user_dir #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM\""},{"path":"/reference/FM_generate_report.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate Report — FM_generate_report","title":"Generate Report — FM_generate_report","text":"Generates report states different modules. type report based file extension file_name.","code":""},{"path":"/reference/FM_generate_report.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate Report — FM_generate_report","text":"","code":"FM_generate_report( state, session, file_dir, file_name, gen_code_only = FALSE, rpterrors = TRUE )"},{"path":"/reference/FM_generate_report.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate Report — FM_generate_report","text":"state Module state requesting report generation session Shiny session variable file_dir path location file written. file_name base_filename (acceptable extensions xlsx, docx, pptx). gen_code_only Boolean value indicating code generated (FALSE). rpterrors Boolean variable generate reports errors.","code":""},{"path":"/reference/FM_generate_report.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate Report — FM_generate_report","text":"List following elements","code":""},{"path":"/reference/FM_generate_report.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Generate Report — FM_generate_report","text":"function look loaded modules find reporting enabbled. reporting enabled look reporting functions module. Reporting functions following format (name arguments): XX_append_report(state, rpt, rpttype) XX module short name. state current state module. rpt contains current content report. vary based report type: xlsx: List two elements. first summary data frame two columns. first column called Sheet_Name second column called Description. catalog sheets added report user can appended using rbind. second element xlsx rpt another list element names corresponding report sheet names values corresponding dataframes exported report. pptx docx: Corresponding onbrand reporting object.","code":""},{"path":"/reference/FM_generate_report.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate Report — FM_generate_report","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This is the directory to write the report: file_dir = tempdir() # This is the file name that determines the type of report to write: file_name = \"my_report.pptx\" rpt_res = FM_generate_report(state = state, session = session, file_dir = file_dir, file_name = file_name, gen_code_only = TRUE, rpterrors = TRUE) #> → FG: Generating report: pptx #> → FG: appending report for module:DW id:DW priority:1 #> → FG: appending report for module:FG id:FG priority:1 # This contains the exit status of the report generation rpt_res$isgood #> [1] TRUE # This is the underlying code that was used to generate the report cat(paste0(rpt_res$code, collapse=\"\\n\")) #> rpt = onbrand::read_template( #> template = file.path(\"config\", \"report.pptx\"), #> mapping = file.path(\"config\", \"report.yaml\")) #> # Figure Fig_1(1): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=1)), #> type = \"ggplot\"))) #> # Figure Fig_1(2): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=2)), #> type = \"ggplot\"))) #> onbrand::save_report(rpt, file.path(\"reports\", \"report.pptx\"))"},{"path":"/reference/FM_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize a formods State Object — FM_init_state","title":"Initialize a formods State Object — FM_init_state","text":"Initializes formods state object common elements.","code":""},{"path":"/reference/FM_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize a formods State Object — FM_init_state","text":"","code":"FM_init_state( FM_yaml_file, MOD_yaml_file, id, dep_mod_ids = c(), MT, button_counters, ui_ids, ui_hold, session )"},{"path":"/reference/FM_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize a formods State Object — FM_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id Shiny module ID. dep_mod_ids Vector module ids module depends . MT Type module using short name (e.g. \"UD\", \"FG\", etc.). button_counters Vector button UI elements need tracked. ui_ids List UI ids module. ui_hold Vector UI elements require holding. session Shiny session variable","code":""},{"path":"/reference/FM_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize a formods State Object — FM_init_state","text":"List state initialized.","code":""},{"path":"/reference/FM_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize a formods State Object — FM_init_state","text":"","code":"# Within shiny a session variable will exist, # this creates examples here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = FM_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), id = \"UD\", MT = \"UD\", button_counters = NULL, ui_ids = NULL, ui_hold = NULL, session = session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] FALSE #> #> $MC$compact$preview #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$labels #> $MC$labels$default_ds #> [1] \"Original data set\" #> #> $MC$labels$upload_button #> [1] \"Select file\" #> #> $MC$labels$tab_main #> [1] \"Upload file\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$tab_preview #> [1] \"Data preview\" #> #> $MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 500 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 500 #> #> $MC$formatting$code$height #> [1] 200 #> #> #> $MC$formatting$switch_clean #> $MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $MC$code #> $MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"myDS\" #> #> $MC$clean_data #> $MC$clean_data$enabled #> [1] TRUE #> #> $MC$clean_data$default #> [1] TRUE #> #> $MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $UD #> $UD$button_counters #> list() #> #> $UD$ui_hold #> list() #> #> $UD$isgood #> [1] TRUE #> #> #> $MOD_TYPE #> [1] \"UD\" #> #> $id #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml\" #>"},{"path":"/reference/FM_le.html","id":null,"dir":"Reference","previous_headings":"","what":"Adds Message to Log File and Displays it to the Console — FM_le","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"Add supplied txt module type log file display console.","code":""},{"path":"/reference/FM_le.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"","code":"FM_le(state, entry, escape_braces = TRUE, entry_type = \"alert\")"},{"path":"/reference/FM_le.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"state Module state yaml read entry Text add escape_braces Set TRUE (default) escape curly braces entry, set FALSE values interpreted. entry_type Set either \"alert\"(default), \"danger\", \"info\", \"success\", \"warning\"","code":""},{"path":"/reference/FM_le.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"Boolean value indicating success (TRUE) failure (FALSE).","code":""},{"path":"/reference/FM_le.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"","code":"# We need a module state to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state FM_le(state, \"This is a normal message\") #> → UD: This is a normal message #> NULL FM_le(state, \"This is a danger message\", entry_type=\"danger\") #> ✖ UD: This is a danger message #> NULL FM_le(state, \"This is a info message\", entry_type=\"info\") #> ℹ UD: This is a info message #> NULL FM_le(state, \"This is a success message\", entry_type=\"success\") #> ✔ UD: This is a success message #> NULL FM_le(state, \"This is a warning message\", entry_type=\"warning\") #> ! UD: This is a warning message #> NULL"},{"path":"/reference/FM_mk_error_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"Takes vector messages returns ggplot object text figure. can used automated figure generation cascade error message end user.","code":""},{"path":"/reference/FM_mk_error_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"","code":"FM_mk_error_fig(msgs)"},{"path":"/reference/FM_mk_error_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"msgs Vector error messages","code":""},{"path":"/reference/FM_mk_error_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"ggplot object","code":""},{"path":"/reference/FM_mk_error_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"","code":"FM_mk_error_fig(\"Oh nos! You've made a mistake!\")"},{"path":"/reference/FM_notify.html","id":null,"dir":"Reference","previous_headings":"","what":"Shiny Notification — FM_notify","title":"Shiny Notification — FM_notify","text":"Generates notification show .","code":""},{"path":"/reference/FM_notify.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shiny Notification — FM_notify","text":"","code":"FM_notify(state, session)"},{"path":"/reference/FM_notify.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shiny Notification — FM_notify","text":"state Module state generating notification session Shiny session variable","code":""},{"path":"/reference/FM_notify.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shiny Notification — FM_notify","text":"Boolean variable indicating notification triggered","code":""},{"path":"/reference/FM_notify.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Shiny Notification — FM_notify","text":"","code":"if(interactive()){ library(formods) library(shiny) library(shinydashboard) #https://fontawesome.com/icons?from=io ui <- dashboardPage( skin=\"red\", dashboardHeader(title=\"Test Notifications\"), dashboardSidebar( sidebarMenu( menuItem(\"Notifications\", tabName=\"example\", icon=icon(\"table\")) ) ), dashboardBody( tabItems( tabItem(tabName=\"example\", fluidRow( shiny::actionButton(\"set_notification\", \"Set Notification\"), shiny::textInput(\"user_text\", label=\"Notify Text Here\", value=\"Notify me\"), shiny::actionButton(\"show_notification\", \"Show Notification\") ) ) ) ) ) # Main app server server <- function(input, output, session) { # Need formods state object sess_res = UD_test_mksession(session, id=\"UD\") # Captures input and sets the notification observeEvent(input$set_notification, { state = FM_fetch_mod_state(session, id=\"UD\") state = FM_set_notification(state, notify_text = isolate(input$user_text), notify_id = \"example\") FM_set_mod_state(session, id=\"UD\", state) }) # Displays the notification observeEvent(input$show_notification, { state = FM_fetch_mod_state(session, id=\"UD\") FM_notify(state, session) }) } shinyApp(ui, server) }"},{"path":"/reference/FM_pause_screen.html","id":null,"dir":"Reference","previous_headings":"","what":"Starts Modal Screen Pause — FM_pause_screen","title":"Starts Modal Screen Pause — FM_pause_screen","text":"Start modal screen pause.","code":""},{"path":"/reference/FM_pause_screen.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Starts Modal Screen Pause — FM_pause_screen","text":"","code":"FM_pause_screen(state, session, message)"},{"path":"/reference/FM_pause_screen.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Starts Modal Screen Pause — FM_pause_screen","text":"state Current module state yaml file read. session Shiny session variable. message Optional message pause.","code":""},{"path":"/reference/FM_pause_screen.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Starts Modal Screen Pause — FM_pause_screen","text":"Pauses screen return value.","code":""},{"path":"/reference/FM_pause_screen.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Starts Modal Screen Pause — FM_pause_screen","text":"","code":"# We need a module state object and Shiny session objects to use this function: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state FM_pause_screen(state, session) #> NULL FM_resume_screen(state, session) #> NULL"},{"path":"/reference/FM_pretty_sort.html","id":null,"dir":"Reference","previous_headings":"","what":"Centralized Sorting Function — FM_pretty_sort","title":"Centralized Sorting Function — FM_pretty_sort","text":"displaying information pull function can used sort options.","code":""},{"path":"/reference/FM_pretty_sort.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Centralized Sorting Function — FM_pretty_sort","text":"","code":"FM_pretty_sort(unsrt_data)"},{"path":"/reference/FM_pretty_sort.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Centralized Sorting Function — FM_pretty_sort","text":"unsrt_data Unsorted data.","code":""},{"path":"/reference/FM_pretty_sort.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Centralized Sorting Function — FM_pretty_sort","text":"sorted data","code":""},{"path":"/reference/FM_pretty_sort.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Centralized Sorting Function — FM_pretty_sort","text":"","code":"# This is the full path to a test data file: data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") # Excel files need a sheet specification: sheet = \"DATA\" # We will also attach the sheets along with it df = readxl::read_excel(path=data_file_local, sheet=sheet) # Regular sorting: sort(unique(df$Cohort)) #> [1] \"MD 10 mg IV\" \"MD 10 mg SC\" \"MD 100 mg IV\" \"MD 100 mg SC\" \"MD 3 mg IV\" #> [6] \"MD 3 mg SC\" \"MD 30 mg IV\" \"MD 30 mg SC\" \"MD 300 mg IV\" \"MD 300 mg SC\" #> [11] \"MD 500 mg IV\" \"MD 500 mg SC\" \"SD 10 mg IV\" \"SD 100 mg IV\" \"SD 3 mg IV\" #> [16] \"SD 30 mg IV\" \"SD 300 mg IV\" \"SD 500 mg IV\" FM_pretty_sort(unique(df$Cohort)) #> [1] \"MD 3 mg IV\" \"MD 3 mg SC\" \"MD 10 mg IV\" \"MD 10 mg SC\" \"MD 30 mg IV\" #> [6] \"MD 30 mg SC\" \"MD 100 mg IV\" \"MD 100 mg SC\" \"MD 300 mg IV\" \"MD 300 mg SC\" #> [11] \"MD 500 mg IV\" \"MD 500 mg SC\" \"SD 3 mg IV\" \"SD 10 mg IV\" \"SD 30 mg IV\" #> [16] \"SD 100 mg IV\" \"SD 300 mg IV\" \"SD 500 mg IV\""},{"path":"/reference/FM_proc_include.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Message in State from UI Processing — FM_proc_include","title":"Sets Message in State from UI Processing — FM_proc_include","text":"errors need passed back user can set function.","code":""},{"path":"/reference/FM_proc_include.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Message in State from UI Processing — FM_proc_include","text":"","code":"FM_proc_include(state, session)"},{"path":"/reference/FM_proc_include.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Message in State from UI Processing — FM_proc_include","text":"state formods State object. session Shiny session variable.","code":""},{"path":"/reference/FM_proc_include.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Message in State from UI Processing — FM_proc_include","text":"return value, sets message supplied session variable.","code":""},{"path":"/reference/FM_proc_include.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Message in State from UI Processing — FM_proc_include","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state session = sess_res$session FM_proc_include(state, session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\")"},{"path":"/reference/FM_resume_screen.html","id":null,"dir":"Reference","previous_headings":"","what":"Stops Modal Screen Pause — FM_resume_screen","title":"Stops Modal Screen Pause — FM_resume_screen","text":"Stops Modal Screen Pause","code":""},{"path":"/reference/FM_resume_screen.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stops Modal Screen Pause — FM_resume_screen","text":"","code":"FM_resume_screen(state, session)"},{"path":"/reference/FM_resume_screen.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stops Modal Screen Pause — FM_resume_screen","text":"state Current module state yaml file read. session Shiny session variable.","code":""},{"path":"/reference/FM_resume_screen.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stops Modal Screen Pause — FM_resume_screen","text":"return value, called disable screen pause.","code":""},{"path":"/reference/FM_resume_screen.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Stops Modal Screen Pause — FM_resume_screen","text":"","code":"# We need a module state object and Shiny session objects to use this function: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state FM_pause_screen(state, session) #> NULL FM_resume_screen(state, session) #> NULL"},{"path":"/reference/FM_set_app_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the App State — FM_set_app_state","title":"Set the App State — FM_set_app_state","text":"Takes loaded app state overwrites current app state","code":""},{"path":"/reference/FM_set_app_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the App State — FM_set_app_state","text":"","code":"FM_set_app_state(session, app_state, set_holds = TRUE)"},{"path":"/reference/FM_set_app_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the App State — FM_set_app_state","text":"session Shiny session variable. app_state Loaded app state. set_holds TRUE (default) holds set modules present app state.","code":""},{"path":"/reference/FM_set_app_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the App State — FM_set_app_state","text":"return value, just updates app state session variable.","code":""},{"path":"/reference/FM_set_app_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the App State — FM_set_app_state","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session app_state = FM_fetch_app_state(session) FM_set_app_state(session, app_state) #> → FM_set_app_state() #> → Unable to find ASM state. #> NULL"},{"path":"/reference/FM_set_mod_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the Module State — FM_set_mod_state","title":"Set the Module State — FM_set_mod_state","text":"Sets module state userdata specified id","code":""},{"path":"/reference/FM_set_mod_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the Module State — FM_set_mod_state","text":"","code":"FM_set_mod_state(session, id, state)"},{"path":"/reference/FM_set_mod_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the Module State — FM_set_mod_state","text":"session Shiny session variable id ID string module. state Module state set.","code":""},{"path":"/reference/FM_set_mod_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the Module State — FM_set_mod_state","text":"Session variable module state set.","code":""},{"path":"/reference/FM_set_mod_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the Module State — FM_set_mod_state","text":"","code":"# We need a Shiny session variable and a module state # object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state FM_set_mod_state(session, id, state) #> $userData #> $userData$FM #> $userData$FM$FM_UD #> $userData$FM$FM_UD$yaml #> $userData$FM$FM_UD$yaml$FM #> $userData$FM$FM_UD$yaml$FM$include #> $userData$FM$FM_UD$yaml$FM$include$files #> $userData$FM$FM_UD$yaml$FM$include$files[[1]] #> $userData$FM$FM_UD$yaml$FM$include$files[[1]]$file #> $userData$FM$FM_UD$yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $userData$FM$FM_UD$yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $userData$FM$FM_UD$yaml$FM$include$files[[2]] #> $userData$FM$FM_UD$yaml$FM$include$files[[2]]$file #> $userData$FM$FM_UD$yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $userData$FM$FM_UD$yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $userData$FM$FM_UD$yaml$FM$include$files[[3]] #> $userData$FM$FM_UD$yaml$FM$include$files[[3]]$file #> $userData$FM$FM_UD$yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $userData$FM$FM_UD$yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $userData$FM$FM_UD$yaml$FM$deployed #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$code #> $userData$FM$FM_UD$yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $userData$FM$FM_UD$yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $userData$FM$FM_UD$yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $userData$FM$FM_UD$yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications #> $userData$FM$FM_UD$yaml$FM$notifications$config #> $userData$FM$FM_UD$yaml$FM$notifications$config$success #> $userData$FM$FM_UD$yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$info #> $userData$FM$FM_UD$yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $userData$FM$FM_UD$yaml$FM$reporting #> $userData$FM$FM_UD$yaml$FM$reporting$enabled #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$reporting$content_init #> $userData$FM$FM_UD$yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $userData$FM$FM_UD$yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $userData$FM$FM_UD$yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $userData$FM$FM_UD$yaml$FM$ui #> $userData$FM$FM_UD$yaml$FM$ui$button_style #> [1] \"fill\" #> #> $userData$FM$FM_UD$yaml$FM$ui$select_size #> [1] 10 #> #> $userData$FM$FM_UD$yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $userData$FM$FM_UD$yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $userData$FM$FM_UD$yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $userData$FM$FM_UD$yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta #> $userData$FM$FM_UD$yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$character #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$double #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$integer #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$other #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $userData$FM$FM_UD$yaml$FM$labels #> $userData$FM$FM_UD$yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $userData$FM$FM_UD$yaml$FM$user_files #> $userData$FM$FM_UD$yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $userData$FM$FM_UD$yaml$FM$logging #> $userData$FM$FM_UD$yaml$FM$logging$enabled #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$logging$timestamp #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $userData$FM$FM_UD$yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $userData$FM$FM_UD$yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $userData$FM$FM_UD$MC #> $userData$FM$FM_UD$MC$compact #> $userData$FM$FM_UD$MC$compact$code #> [1] FALSE #> #> $userData$FM$FM_UD$MC$compact$preview #> [1] TRUE #> #> #> $userData$FM$FM_UD$MC$reporting #> $userData$FM$FM_UD$MC$reporting$enabled #> [1] FALSE #> #> $userData$FM$FM_UD$MC$reporting$priority #> [1] 1 #> #> #> $userData$FM$FM_UD$MC$labels #> $userData$FM$FM_UD$MC$labels$default_ds #> [1] \"Original data set\" #> #> $userData$FM$FM_UD$MC$labels$upload_button #> [1] \"Select file\" #> #> $userData$FM$FM_UD$MC$labels$tab_main #> [1] \"Upload file\" #> #> $userData$FM$FM_UD$MC$labels$tab_code #> [1] \"Code\" #> #> $userData$FM$FM_UD$MC$labels$tab_preview #> [1] \"Data preview\" #> #> $userData$FM$FM_UD$MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $userData$FM$FM_UD$MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $userData$FM$FM_UD$MC$tooltips #> $userData$FM$FM_UD$MC$tooltips$include #> [1] TRUE #> #> $userData$FM$FM_UD$MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $userData$FM$FM_UD$MC$formatting #> $userData$FM$FM_UD$MC$formatting$preview #> $userData$FM$FM_UD$MC$formatting$preview$width #> [1] 800 #> #> $userData$FM$FM_UD$MC$formatting$preview$height #> [1] 500 #> #> #> $userData$FM$FM_UD$MC$formatting$code #> $userData$FM$FM_UD$MC$formatting$code$width #> [1] 500 #> #> $userData$FM$FM_UD$MC$formatting$code$height #> [1] 200 #> #> #> $userData$FM$FM_UD$MC$formatting$switch_clean #> $userData$FM$FM_UD$MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $userData$FM$FM_UD$MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $userData$FM$FM_UD$MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $userData$FM$FM_UD$MC$code #> $userData$FM$FM_UD$MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $userData$FM$FM_UD$MC$code$readOnly #> [1] TRUE #> #> $userData$FM$FM_UD$MC$code$mode #> [1] \"r\" #> #> $userData$FM$FM_UD$MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $userData$FM$FM_UD$MC$ds_object_name #> [1] \"myDS\" #> #> $userData$FM$FM_UD$MC$clean_data #> $userData$FM$FM_UD$MC$clean_data$enabled #> [1] TRUE #> #> $userData$FM$FM_UD$MC$clean_data$default #> [1] TRUE #> #> $userData$FM$FM_UD$MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $userData$FM$FM_UD$UD #> $userData$FM$FM_UD$UD$isgood #> [1] TRUE #> #> $userData$FM$FM_UD$UD$clean #> [1] TRUE #> #> $userData$FM$FM_UD$UD$load_msg #> <em>File loaded.<\/em> #> #> $userData$FM$FM_UD$UD$data_file_local #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/FM/TEST_DATA.xlsx\" #> #> $userData$FM$FM_UD$UD$data_file_ext #> [1] \"xlsx\" #> #> $userData$FM$FM_UD$UD$data_file #> [1] \"TEST_DATA.xlsx\" #> #> $userData$FM$FM_UD$UD$sheet #> NULL #> #> $userData$FM$FM_UD$UD$sheets #> [1] \"DATA\" \"DDT\" #> #> $userData$FM$FM_UD$UD$code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $userData$FM$FM_UD$UD$object_name #> [1] \"myDS\" #> #> $userData$FM$FM_UD$UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $userData$FM$FM_UD$UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> #> $userData$FM$FM_UD$MOD_TYPE #> [1] \"UD\" #> #> $userData$FM$FM_UD$id #> [1] \"UD\" #> #> $userData$FM$FM_UD$FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $userData$FM$FM_UD$MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml\" #> #> #> #>"},{"path":"/reference/FM_set_notification.html","id":null,"dir":"Reference","previous_headings":"","what":"Shiny Notification — FM_set_notification","title":"Shiny Notification — FM_set_notification","text":"Generates notification show .","code":""},{"path":"/reference/FM_set_notification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shiny Notification — FM_set_notification","text":"","code":"FM_set_notification(state, notify_text, notify_id, type = \"info\")"},{"path":"/reference/FM_set_notification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shiny Notification — FM_set_notification","text":"state Module state generating notification notify_text Text go notification notify_id Unique string notification type - Can either \"success\", \"failure\", \"info\" (default), \"warning\"","code":""},{"path":"/reference/FM_set_notification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shiny Notification — FM_set_notification","text":"Module state notification text set","code":""},{"path":"/reference/FM_set_notification.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Shiny Notification — FM_set_notification","text":"","code":"if(interactive()){ library(formods) library(shiny) library(shinydashboard) #https://fontawesome.com/icons?from=io ui <- dashboardPage( skin=\"red\", dashboardHeader(title=\"Test Notifications\"), dashboardSidebar( sidebarMenu( menuItem(\"Notifications\", tabName=\"example\", icon=icon(\"table\")) ) ), dashboardBody( tabItems( tabItem(tabName=\"example\", fluidRow( shiny::actionButton(\"set_notification\", \"Set Notification\"), shiny::textInput(\"user_text\", label=\"Notify Text Here\", value=\"Notify me\"), shiny::actionButton(\"show_notification\", \"Show Notification\") ) ) ) ) ) # Main app server server <- function(input, output, session) { # Need formods state object sess_res = UD_test_mksession(session, id=\"UD\") # Captures input and sets the notification observeEvent(input$set_notification, { state = FM_fetch_mod_state(session, id=\"UD\") state = FM_set_notification(state, notify_text = isolate(input$user_text), notify_id = \"example\") FM_set_mod_state(session, id=\"UD\", state) }) # Displays the notification observeEvent(input$show_notification, { state = FM_fetch_mod_state(session, id=\"UD\") FM_notify(state, session) }) } shinyApp(ui, server) }"},{"path":"/reference/FM_set_ui_msg.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Message in State from UI Processing — FM_set_ui_msg","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"errors need passed back user can set function.","code":""},{"path":"/reference/FM_set_ui_msg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"","code":"FM_set_ui_msg(state, msgs, append = FALSE)"},{"path":"/reference/FM_set_ui_msg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"state formods State object. msgs Character vector messages. append TRUE, msgs appended current messages. FALSE (default) msgs replace existing messaages.","code":""},{"path":"/reference/FM_set_ui_msg.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"state ui message set.","code":""},{"path":"/reference/FM_set_ui_msg.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state state = FM_set_ui_msg(state, \"Something happend.\")"},{"path":"/reference/FM_tc.html","id":null,"dir":"Reference","previous_headings":"","what":"Run Try/Catch and Process Results — FM_tc","title":"Run Try/Catch and Process Results — FM_tc","text":"Attempts execute text cmd. done try/catch environment capture errors.","code":""},{"path":"/reference/FM_tc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run Try/Catch and Process Results — FM_tc","text":"","code":"FM_tc(cmd, tc_env, capture)"},{"path":"/reference/FM_tc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run Try/Catch and Process Results — FM_tc","text":"cmd Character object containing R command evaluate try/catch block tc_env list names corresponding object names corresponding Values define try/catch environment capture Character vector values capture command successfully captured","code":""},{"path":"/reference/FM_tc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run Try/Catch and Process Results — FM_tc","text":"list following fields: isgood: Boolean indicating whether evaluation successful. error: evaluation failed contains error object. msgs: Character vector messages /errors. capture: List names objects captured values corresponding captured objects.","code":""},{"path":"/reference/FM_tc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run Try/Catch and Process Results — FM_tc","text":"","code":"# Successful command res_good = FM_tc(\"good_cmd=ls()\", list(), c(\"good_cmd\")) res_good #> $capture #> $capture$good_cmd #> [1] \"capture\" \"cmd\" \"isgood\" \"msgs\" \"name\" \"tc_env\" \"tcres\" #> #> #> $isgood #> [1] TRUE #> # Failed command res_bad = FM_tc(\"bad_cmd =not_a_command()\", list(), c(\"bad_cmd\")) res_bad #> $error #> <simpleError in not_a_command(): could not find function \"not_a_command\"> #> #> $isgood #> [1] FALSE #> #> $msgs #> [1] \"message: could not find function \\\"not_a_command\\\"\" #> [2] \"call: not_a_command\" #>"},{"path":"/reference/UD_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Data Upload Server — UD_Server","title":"Data Upload Server — UD_Server","text":"Server function Data Uplaod Shiny Module","code":""},{"path":"/reference/UD_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Data Upload Server — UD_Server","text":"","code":"UD_Server( id, id_ASM = \"ASM\", FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), deployed = FALSE, react_state = NULL )"},{"path":"/reference/UD_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Data Upload Server — UD_Server","text":"id ID string corresponds ID used call modules UI elements id_ASM ID string app state management module used save load app states FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/UD_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Data Upload Server — UD_Server","text":"UD Server object","code":""},{"path":"/reference/UD_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Data Upload Server — UD_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/UD_attach_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Attach Data Set to UD State — UD_attach_ds","title":"Attach Data Set to UD State — UD_attach_ds","text":"Attaches dataset UD state supplied.","code":""},{"path":"/reference/UD_attach_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attach Data Set to UD State — UD_attach_ds","text":"","code":"UD_attach_ds( state, clean = NULL, isgood = TRUE, load_msg = NULL, data_file_local = NULL, data_file_ext = NULL, data_file = NULL, sheet = NULL, sheets = NULL, code = \"\", object_name = NULL, contents = NULL )"},{"path":"/reference/UD_attach_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attach Data Set to UD State — UD_attach_ds","text":"state UD state module. clean Boolean switch determine headers loaded dataset cleaned. isgood Boolean object indicating file successfully loaded. load_msg Text message indicated success problems encountered uploading file. data_file_local Full path data file server. data_file_ext File extension uploaded file. data_file Dataset file name without path. sheet uploaded file excel file, currently selected sheet. sheets uploaded file excel file, character vector sheets present file. code Code load dataset. object_name Name dataset object created code evaluated. contents Data frame containting contents data file.","code":""},{"path":"/reference/UD_attach_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attach Data Set to UD State — UD_attach_ds","text":"state data set attached","code":""},{"path":"/reference/UD_attach_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attach Data Set to UD State — UD_attach_ds","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state # This is the full path to a test data file: data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") # Excel file extension data_file_ext = \"xlsx\" # Base file name data_file = \"TEST_DATA.xlsx\" # Excel files need a sheet specification: sheet = \"DATA\" # We will also attach the sheets along with it sheets = readxl::excel_sheets(data_file_local) ds_read_res = UD_ds_read(state, data_file_ext = data_file_ext, data_file_local = data_file_local, data_file = data_file, sheets = sheets, sheet = sheet) # This would contain the loading code that will cascade down # to the other modules when generating snippets and # reproducible scripts code = ds_read_res$code # This is the R Object name that is used internally # and in generated scripts. Should be the same as in # the code above object_name = ds_read_res$object_name # This is the actual dataset: contents = ds_read_res$contents state = UD_attach_ds( state, data_file_local = data_file_local, data_file_ext = \".xlsx\", data_file = data_file, sheet = sheet, sheets = sheets, code = code, object_name = object_name, contents = contents) state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] FALSE #> #> $MC$compact$preview #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$labels #> $MC$labels$default_ds #> [1] \"Original data set\" #> #> $MC$labels$upload_button #> [1] \"Select file\" #> #> $MC$labels$tab_main #> [1] \"Upload file\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$tab_preview #> [1] \"Data preview\" #> #> $MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 500 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 500 #> #> $MC$formatting$code$height #> [1] 200 #> #> #> $MC$formatting$switch_clean #> $MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $MC$code #> $MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"myDS\" #> #> $MC$clean_data #> $MC$clean_data$enabled #> [1] TRUE #> #> $MC$clean_data$default #> [1] TRUE #> #> $MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $UD #> $UD$isgood #> [1] TRUE #> #> $UD$clean #> NULL #> #> $UD$load_msg #> NULL #> #> $UD$data_file_local #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/test_data/TEST_DATA.xlsx\" #> #> $UD$data_file_ext #> [1] \".xlsx\" #> #> $UD$data_file #> [1] \"TEST_DATA.xlsx\" #> #> $UD$sheet #> [1] \"DATA\" #> #> $UD$sheets #> [1] \"DATA\" \"DDT\" #> #> $UD$code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $UD$object_name #> [1] \"myDS\" #> #> $UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> #> $MOD_TYPE #> [1] \"UD\" #> #> $id #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml\" #>"},{"path":"/reference/UD_ds_read.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate Code and Load DS — UD_ds_read","title":"Generate Code and Load DS — UD_ds_read","text":"Generates code loading dataset returns code contents","code":""},{"path":"/reference/UD_ds_read.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate Code and Load DS — UD_ds_read","text":"","code":"UD_ds_read( state, data_file_ext = NULL, data_file_local = NULL, data_file = NULL, sheets = NULL, sheet = NULL )"},{"path":"/reference/UD_ds_read.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate Code and Load DS — UD_ds_read","text":"state UD state UD_fetch_state() data_file_ext File extension uploaded file (e.g. \"xlsx\", \"csv\", etc). data_file_local Full path data file server. data_file Dataset file name without path. sheets uploaded file excel file, character vector sheets present file. sheet uploaded file excel file, currently selected sheet.","code":""},{"path":"/reference/UD_ds_read.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate Code and Load DS — UD_ds_read","text":"list elements dataset (contents, object_name, code, isgood)","code":""},{"path":"/reference/UD_ds_read.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate Code and Load DS — UD_ds_read","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state # This is the full path to a test data file: data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") # Excel file extension data_file_ext = \"xlsx\" # Base file name data_file = \"TEST_DATA.xlsx\" # Excel files need a sheet specification: sheet = \"DATA\" # We will also attach the sheets along with it sheets = readxl::excel_sheets(data_file_local) ds_read_res = UD_ds_read(state, data_file_ext = data_file_ext, data_file_local = data_file_local, data_file = data_file, sheets = sheets, sheet = sheet) ds_read_res #> $contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> $object_name #> [1] \"myDS\" #> #> $isgood #> [1] TRUE #> #> $code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #>"},{"path":"/reference/UD_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — UD_fetch_code","title":"Fetch Module Code — UD_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/UD_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — UD_fetch_code","text":"","code":"UD_fetch_code(state)"},{"path":"/reference/UD_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — UD_fetch_code","text":"state UD state UD_fetch_state()","code":""},{"path":"/reference/UD_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — UD_fetch_code","text":"Character object vector lines code","code":""},{"path":"/reference/UD_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — UD_fetch_code","text":"","code":"# This creates a session variable that will be available in Shiny state = UD_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 UD_fetch_code(state) #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\""},{"path":"/reference/UD_fetch_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Datasets — UD_fetch_ds","title":"Fetch Module Datasets — UD_fetch_ds","text":"Fetches datasets contained module.","code":""},{"path":"/reference/UD_fetch_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Datasets — UD_fetch_ds","text":"","code":"UD_fetch_ds(state)"},{"path":"/reference/UD_fetch_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Datasets — UD_fetch_ds","text":"state UD state UD_fetch_state()","code":""},{"path":"/reference/UD_fetch_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Datasets — UD_fetch_ds","text":"Character object vector lines code list containing following elements isgood: Return status function. hasds: Boolean indicator module datasets msgs: Messages passed back user. ds: List datasets. list element name R-object dataset. element following structure: label: Text label dataset MOD_TYPE: Short name type module. id: module ID DS: Dataframe containing actual dataset. DSMETA: Metadata describing DS, see FM_fetch_ds() details format. code: Complete code build dataset. checksum: Module checksum. DSchecksum: Dataset checksum.","code":""},{"path":"/reference/UD_fetch_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Datasets — UD_fetch_ds","text":"","code":"# YAML configuration files from the package: FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\") # This is the module id: id = \"UD\" # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session input = sess_res$input state = UD_fetch_state( id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file ) #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 ds_res = UD_fetch_ds(state)"},{"path":"/reference/UD_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Upload Data State — UD_fetch_state","title":"Fetch Upload Data State — UD_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/UD_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Upload Data State — UD_fetch_state","text":"","code":"UD_fetch_state(id, id_ASM, input, session, FM_yaml_file, MOD_yaml_file)"},{"path":"/reference/UD_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Upload Data State — UD_fetch_state","text":"id Shiny module ID id_ASM ID string app state management module used save load app states input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section.","code":""},{"path":"/reference/UD_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Upload Data State — UD_fetch_state","text":"list containing current state app including default values yaml file well changes made user. list following structure: yaml: Full contents supplied yaml file. MC: Module components yaml file. DS: Loaded dataset following elements isgood: Boolean object indicating file successfully loaded. load_msg: Text message indicated success problems encountered uploading file. data_file_local: Full path data file server. data_file: Dataset file name without path. data_file_ext: File extension uploaded file. sheet: uploaded file excel file, currently selected sheet. sheets: uploaded file excel file, character vector sheets present file. contents: Data frame containting contents data file. checksum: MD5 sum contents element can used detect changes loaded file. MOD_TYPE: Character data containing type module \"UD\" id: Character data containing module id module session variable. FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section.","code":""},{"path":"/reference/UD_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Upload Data State — UD_fetch_state","text":"","code":"# YAML configuration files from the package: FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\") # This is the module id: id = \"UD\" # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session input = sess_res$input state = UD_fetch_state( id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file ) #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20"},{"path":"/reference/UD_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize UD Module State — UD_init_state","title":"Initialize UD Module State — UD_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/UD_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize UD Module State — UD_init_state","text":"","code":"UD_init_state(FM_yaml_file, MOD_yaml_file, id, session)"},{"path":"/reference/UD_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize UD Module State — UD_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id ID string module. session Shiny session variable","code":""},{"path":"/reference/UD_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize UD Module State — UD_init_state","text":"list containing empty UD state","code":""},{"path":"/reference/UD_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize UD Module State — UD_init_state","text":"","code":"# Within shiny a session variable will exist, # this creates one here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = UD_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), id = \"UD\", session = session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] FALSE #> #> $MC$compact$preview #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$labels #> $MC$labels$default_ds #> [1] \"Original data set\" #> #> $MC$labels$upload_button #> [1] \"Select file\" #> #> $MC$labels$tab_main #> [1] \"Upload file\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$tab_preview #> [1] \"Data preview\" #> #> $MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 500 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 500 #> #> $MC$formatting$code$height #> [1] 200 #> #> #> $MC$formatting$switch_clean #> $MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $MC$code #> $MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"myDS\" #> #> $MC$clean_data #> $MC$clean_data$enabled #> [1] TRUE #> #> $MC$clean_data$default #> [1] TRUE #> #> $MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $UD #> $UD$isgood #> [1] FALSE #> #> $UD$clean #> [1] TRUE #> #> $UD$load_msg #> NULL #> #> $UD$data_file_local #> NULL #> #> $UD$data_file_ext #> NULL #> #> $UD$data_file #> NULL #> #> $UD$sheet #> NULL #> #> $UD$sheets #> NULL #> #> $UD$code #> [1] \"\" #> #> $UD$object_name #> [1] \"myDS\" #> #> $UD$checksum #> [1] \"451f5a07b45f62763a93eb83c0bdbc3c\" #> #> $UD$contents #> NULL #> #> #> $MOD_TYPE #> [1] \"UD\" #> #> $id #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/UD.yaml\" #>"},{"path":"/reference/UD_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — UD_test_mksession","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/UD_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"","code":"UD_test_mksession(session, id = \"UD\")"},{"path":"/reference/UD_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements","code":""},{"path":"/reference/UD_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/UD_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"","code":"res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20"},{"path":"/reference/autocast.html","id":null,"dir":"Reference","previous_headings":"","what":"Automatically Cast UI Input Variable — autocast","title":"Automatically Cast UI Input Variable — autocast","text":"Takes UI input tries figure numeric text","code":""},{"path":"/reference/autocast.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Automatically Cast UI Input Variable — autocast","text":"","code":"autocast(ui_input, quote_char = TRUE)"},{"path":"/reference/autocast.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Automatically Cast UI Input Variable — autocast","text":"ui_input UI input shiny form quote_char TRUE include double quotes character string","code":""},{"path":"/reference/autocast.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Automatically Cast UI Input Variable — autocast","text":"Best guess type casting applied ui_input","code":""},{"path":"/reference/autocast.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Automatically Cast UI Input Variable — autocast","text":"","code":"number = autocast('10') text = autocast('ten') #> Warning: NAs introduced by coercion"},{"path":"/reference/dw_eval_element.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluates Data Wrangling Generated Code — dw_eval_element","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"Takes current state string containing data wranlging command evaluates .","code":""},{"path":"/reference/dw_eval_element.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"","code":"dw_eval_element(state, cmd)"},{"path":"/reference/dw_eval_element.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"state DW state DW_fetch_state() cmd string containing data wrangling command","code":""},{"path":"/reference/dw_eval_element.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"list following elements isgood: Return status function. msgs: Messages passed back user. DS: Wrangled dataset.","code":""},{"path":"/reference/dw_eval_element.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/dwrs_builder.html","id":null,"dir":"Reference","previous_headings":"","what":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"Takes current ui elements constructs appropriate data wrangling command user input.","code":""},{"path":"/reference/dwrs_builder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"","code":"dwrs_builder(state)"},{"path":"/reference/dwrs_builder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/dwrs_builder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"list containing following elements isgood: Return status function cmd: Data wrangling R command action: action performed desc: Verbose description action msgs: Messages passed back user","code":""},{"path":"/reference/dwrs_builder.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/fers_builder.html","id":null,"dir":"Reference","previous_headings":"","what":"Builds a Figure Element R Statement From UI Elements: — fers_builder","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"Takes current ui elements constructs appropriate ggplot commands forom user input. plot commands assume existance ggplot object p.","code":""},{"path":"/reference/fers_builder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"","code":"fers_builder(state)"},{"path":"/reference/fers_builder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/fers_builder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"list containing following elements isgood: Return status function. cmd: ggplot R command character string element: type element added desc: Verbose description element msgs: Messages passed back user","code":""},{"path":"/reference/fers_builder.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"","code":"sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:6a4a57c65a0381b209bbc258b7e738c9 #> → FG: module checksum updated:d0e91ddb9b96e9cc04f66275661cf11a #> → FG: module checksum updated:e1aa3c7146996c17adfe5c864ece958f state = sess_res$state fb_res = fers_builder(state)"},{"path":"/reference/fetch_hold.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Hold Status UI Element Supplied — fetch_hold","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"buttons clicked change state system, UI components detect change correctly. triggers put hold. fetch hold status specified inputId","code":""},{"path":"/reference/fetch_hold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"","code":"fetch_hold(state, inputId = NULL)"},{"path":"/reference/fetch_hold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"state module state current ui elements populated inputId input ID UI element put hold","code":""},{"path":"/reference/fetch_hold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"Boolean value hold status","code":""},{"path":"/reference/fetch_hold.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # For this example we also need a state variable state = sess_res$state # This sets a hold on the specified inputID. This is normally done in # your XX_fetch_state() function. state = set_hold(state, inputId = \"select_dw_views\") # This will fetch the hold status of the specified inputID. fetch_hold(state, inputId = \"select_dw_views\") #> [1] TRUE # This will remove the hold and is normally done in one of the UI outputs # with a priority set to ensure it happens after the rest of the UI has # refreshed. state = remove_hold(state, session, inputId = \"select_dw_views\")"},{"path":"/reference/fetch_package_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Current Version of Pacakge — fetch_package_version","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"specified package version extracted returned. can simply version installed CRAN development version GitHub used details returned.","code":""},{"path":"/reference/fetch_package_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"","code":"fetch_package_version(pkgname)"},{"path":"/reference/fetch_package_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"pkgname Name package","code":""},{"path":"/reference/fetch_package_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"String version information","code":""},{"path":"/reference/fetch_package_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"","code":"# This package should exist fetch_package_version('digest') #> $isgood #> [1] TRUE #> #> $msgs #> NULL #> #> $version_verb #> [1] \"0.6.31 (2022-12-11, CRAN (R 4.2.0))\" #> #> $version #> [1] \"0.6.31\" #> # This package should not exist fetch_package_version('bad package name') #> $isgood #> [1] FALSE #> #> $msgs #> [1] \"The package: bad package name was not found. You may need to load it first.\" #> #> $version_verb #> [1] \"NA\" #> #> $version #> [1] \"NA\" #>"},{"path":"/reference/formods.html","id":null,"dir":"Reference","previous_headings":"","what":"formods: Shiny modules for common tasks. — formods","title":"formods: Shiny modules for common tasks. — formods","text":"Shiny apps can often make use key elements, package provides modules common tasks (data upload, wrangling data, figure generation saving app state). modules can react interact well generate code create reproducible analyses.","code":""},{"path":[]},{"path":"/reference/formods.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"formods: Shiny modules for common tasks. — formods","text":"Maintainer: John Harrold john.m.harrold@gmail.com (ORCID)","code":""},{"path":"/reference/has_changed.html","id":null,"dir":"Reference","previous_headings":"","what":"Detect if a UI element has changed — has_changed","title":"Detect if a UI element has changed — has_changed","text":"Takes UI element value older value determines modified","code":""},{"path":"/reference/has_changed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Detect if a UI element has changed — has_changed","text":"","code":"has_changed(ui_val = NULL, old_val = NULL, init_value = c(\"\"))"},{"path":"/reference/has_changed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Detect if a UI element has changed — has_changed","text":"ui_val Current value UI. old_val Last value element. init_value Default value reading UI data defined.","code":""},{"path":"/reference/has_changed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Detect if a UI element has changed — has_changed","text":"Boolean result comparison","code":""},{"path":"/reference/has_changed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Detect if a UI element has changed — has_changed","text":"","code":"changed_true = has_changed(ui_val = \"a\", old_val = \"\") changed_true #> [1] TRUE changed_false = has_changed(ui_val = \"a\", old_val = \"a\") changed_false #> [1] FALSE"},{"path":"/reference/icon_link.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates Icon Link — icon_link","title":"Creates Icon Link — icon_link","text":"Creates link Shiny icon","code":""},{"path":"/reference/icon_link.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates Icon Link — icon_link","text":"","code":"icon_link(href, target = \"_blank\", icon_name = \"circle-info\")"},{"path":"/reference/icon_link.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates Icon Link — icon_link","text":"href URL link . target New tab name. icon_name Name icon use (arguemnt shiny::icon, default: \"circle-info\")","code":""},{"path":"/reference/icon_link.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates Icon Link — icon_link","text":"list shiny.tag class can converted HTML string via .character() saved file save_html()","code":""},{"path":"/reference/icon_link.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Creates Icon Link — icon_link","text":"","code":"icon_link(href=\"https://formods.ubiquity.tools\") #> <a href=\"https://formods.ubiquity.tools\" target=\"_blank\"> #> <i class=\"fas fa-circle-info\" role=\"presentation\" aria-label=\"circle-info icon\"><\/i> #> <\/a>"},{"path":"/reference/is_installed.html","id":null,"dir":"Reference","previous_headings":"","what":"Determines if a Package is Installed — is_installed","title":"Determines if a Package is Installed — is_installed","text":"Determines specified package installed.","code":""},{"path":"/reference/is_installed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Determines if a Package is Installed — is_installed","text":"","code":"is_installed(pkgname)"},{"path":"/reference/is_installed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Determines if a Package is Installed — is_installed","text":"pkgname Name package","code":""},{"path":"/reference/is_installed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Determines if a Package is Installed — is_installed","text":"Logical indicating packages installed ","code":""},{"path":"/reference/is_installed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Determines if a Package is Installed — is_installed","text":"","code":"# This package should exist is_installed('digest') #> [1] TRUE # This package should not exist is_installed('bad package name') #> [1] FALSE"},{"path":"/reference/new_module_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Makes Template Files for formods New Module — new_module_template","title":"Makes Template Files for formods New Module — new_module_template","text":"want create new formods module function create template files .","code":""},{"path":"/reference/new_module_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Makes Template Files for formods New Module — new_module_template","text":"","code":"new_module_template( SN = \"NM\", Module_Name = \"New Module\", package = \"pkgname\", element = \"analysis\", file_dir = tempdir() )"},{"path":"/reference/new_module_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Makes Template Files for formods New Module — new_module_template","text":"SN Module short name Module_Name Module long name package Name package contain module element call thing module provides example FG module provides \"figures\", DW module provides \"data views\". file_dir Directory save file","code":""},{"path":"/reference/new_module_template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Makes Template Files for formods New Module — new_module_template","text":"list following elements: mc: Module components. server: Server.R file. yaml: Yaml configureation file. list paths respective files: source: Template source. dest: Destination file name. dest_full: Full path destination file name.","code":""},{"path":"/reference/new_module_template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Makes Template Files for formods New Module — new_module_template","text":"","code":"new_module_template() #> $mc #> $mc$source #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ZZ_module_components.R\" #> #> $mc$dest #> [1] \"NM_module_components.R\" #> #> $mc$dest_full #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/NM_module_components.R\" #> #> #> $server #> $server$source #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ZZ_Server.R\" #> #> $server$dest #> [1] \"NM_Server.R\" #> #> $server$dest_full #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/NM_Server.R\" #> #> #> $yaml #> $yaml$source #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd6e5ef7e2/formods/templates/ZZ.yaml\" #> #> $yaml$dest #> [1] \"NM.yaml\" #> #> $yaml$dest_full #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//Rtmpr7zAgJ/NM.yaml\" #> #>"},{"path":"/reference/remove_hold.html","id":null,"dir":"Reference","previous_headings":"","what":"Removes Hold on UI Element — remove_hold","title":"Removes Hold on UI Element — remove_hold","text":"buttons clicked change state system, UI components detect change correctly. triggers put hold. remove hold UI components updated.","code":""},{"path":"/reference/remove_hold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Removes Hold on UI Element — remove_hold","text":"","code":"remove_hold(state, session, inputId)"},{"path":"/reference/remove_hold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Removes Hold on UI Element — remove_hold","text":"state module state current ui elements populated session Shiny session variable inputId input ID UI element put hold","code":""},{"path":"/reference/remove_hold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Removes Hold on UI Element — remove_hold","text":"return value, called remove holds.","code":""},{"path":"/reference/remove_hold.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Removes Hold on UI Element — remove_hold","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # For this example we also need a state variable state = sess_res$state # This sets a hold on the specified inputID. This is normally done in # your XX_fetch_state() function. state = set_hold(state, inputId = \"select_dw_views\") # This will fetch the hold status of the specified inputID. fetch_hold(state, inputId = \"select_dw_views\") #> [1] TRUE # This will remove the hold and is normally done in one of the UI outputs # with a priority set to ensure it happens after the rest of the UI has # refreshed. state = remove_hold(state, session, inputId = \"select_dw_views\")"},{"path":"/reference/set_hold.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Hold on One or All UI Elements — set_hold","title":"Sets Hold on One or All UI Elements — set_hold","text":"buttons clicked change state system, UI components detect change correctly. triggers put hold. set hold specified inputId ids value set NULL","code":""},{"path":"/reference/set_hold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Hold on One or All UI Elements — set_hold","text":"","code":"set_hold(state, inputId = NULL)"},{"path":"/reference/set_hold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Hold on One or All UI Elements — set_hold","text":"state module state current ui elements populated inputId input ID UI element put hold NULL hold IDs module","code":""},{"path":"/reference/set_hold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Hold on One or All UI Elements — set_hold","text":"state hold holds set","code":""},{"path":"/reference/set_hold.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Hold on One or All UI Elements — set_hold","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # For this example we also need a state variable state = sess_res$state # This sets a hold on the specified inputID. This is normally done in # your XX_fetch_state() function. state = set_hold(state, inputId = \"select_dw_views\") # This will fetch the hold status of the specified inputID. fetch_hold(state, inputId = \"select_dw_views\") #> [1] TRUE # This will remove the hold and is normally done in one of the UI outputs # with a priority set to ensure it happens after the rest of the UI has # refreshed. state = remove_hold(state, session, inputId = \"select_dw_views\")"},{"path":"/reference/unfactor.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove Factor From Object — unfactor","title":"Remove Factor From Object — unfactor","text":"Takes object factor returns unfactored vector type value removed","code":""},{"path":"/reference/unfactor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove Factor From Object — unfactor","text":"","code":"unfactor(fctobj)"},{"path":"/reference/unfactor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove Factor From Object — unfactor","text":"fctobj Factorized object","code":""},{"path":"/reference/unfactor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove Factor From Object — unfactor","text":"Object factors removed","code":""},{"path":"/reference/unfactor.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove Factor From Object — unfactor","text":"","code":"df = data.frame( text = c(\"a\", \"b\", \"c\"), float = c( 1 , 2 , 3 )) df$float = as.factor(df$float) # This is a factor df$float #> [1] 1 2 3 #> Levels: 1 2 3 # This is not a factor unfactor(df$float) #> [1] 1 2 3"},{"path":"/reference/use_formods.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Module Templates in a Package Repository — use_formods","title":"Create Module Templates in a Package Repository — use_formods","text":"developing package within repository (.e. git) want create new formods module function create template files install correct location.","code":""},{"path":"/reference/use_formods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Module Templates in a Package Repository — use_formods","text":"","code":"use_formods( SN = \"NM\", Module_Name = \"New Module\", package = \"pkgname\", element = \"analysis\", overwrite = FALSE, repo_root = NULL )"},{"path":"/reference/use_formods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Module Templates in a Package Repository — use_formods","text":"SN Module short name Module_Name Module long name package Name package contain module element call thing module provides example FG module provides \"figures\", DW module provides \"data views\" overwrite Boolean indicate overwrite files repo_root Root repository.","code":""},{"path":"/reference/use_formods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Module Templates in a Package Repository — use_formods","text":"return value new_module_template()","code":""},{"path":"/reference/use_formods.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Module Templates in a Package Repository — use_formods","text":"","code":"if(FALSE){ use_formods(repo_root=tempdir()) }"},{"path":"/news/index.html","id":"formods-012","dir":"Changelog","previous_headings":"","what":"formods 0.1.2","title":"formods 0.1.2","text":"development version Added new_module_template() create new module templates use_formods() automatically add files package. Updated app info ASM split uiele diferent components.","code":""},{"path":"/news/index.html","id":"formods-011","dir":"Changelog","previous_headings":"","what":"formods 0.1.1","title":"formods 0.1.1","text":"CRAN release: 2023-08-17 Initial release","code":""}]
+[{"path":"/articles/included_modules.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Included Modules","text":"ever make Shiny app think: Didn’t just stuff last week? creating data upload forms generating UI building ggplot figures certain components use apps. purpose formods create customizable Shiny modules allow many components created quickly can focus part app unique interesting. modules formods generates code dynamically produce underlying outputs. allows modules combined framework generate code allows state apps reproduced single script.","code":""},{"path":"/articles/included_modules.html","id":"implementation","dir":"Articles","previous_headings":"Introduction","what":"Implementation","title":"Included Modules","text":"module short name used functions namespaces. example upload data module use UD. use module need create appropriate UI elements well call module server. high level formods components individual modules configured YAML configuration files.","code":""},{"path":"/articles/included_modules.html","id":"avialable-modules","dir":"Articles","previous_headings":"","what":"Avialable modules","title":"Included Modules","text":"currently available modules listed table . SN column contains short name used identify module. individual HTML UI elements listed well UI outputs. Module SN htmlOutput Outputs App State Mangement ASM ui_asm_save_name, ui_asm_save_button, ui_asm_load_state ui_asm_msg, ui_asm_ace_code Upload Data UD ui_ud_load_data, ui_ud_select_sheets, ui_ud_text_load_result, ui_ud_data_preview ui_ud_ace_code Data Wrangling DW ui_dw_views, ui_dw_key, ui_dw_new_view, ui_dw_save_view, ui_dw_del_view, ui_dw_copy_view, ui_dw_add_element_button, ui_dw_select, ui_dw_new_element_row hot_dw_elements, hot_data_preview, ui_dw_msg, ui_dw_code Figure Generation FG ui_fg_curr_views, ui_fg_curr_figs, ui_fg_new_fig, ui_fg_save_fig, ui_fg_del_fig, ui_fg_copy_fig, ui_fg_fig_name, ui_fg_fig_notes, ui_fg_add_element_button, ui_fg_select, ui_fg_new_element_row, ui_fg_msg, ui_fg_slider_page hot_fg_elements, ui_fg_preview_ggplot, ui_fg_msg, ui_fg_code","code":""},{"path":"/articles/included_modules.html","id":"using-a-module","dir":"Articles","previous_headings":"Avialable modules","what":"Using a module","title":"Included Modules","text":"Using module requires two components: need add UI elements module, need add server component well. Take care use id UI server components. UI elements listed table . Also module formods contains example App file isolates UI component allow see ’s used. called XX_module_components.R, XX module short name. example see example upload data module run following copy file locally: want run App within package can just following:","code":"copy.file(system.file(package=\"formods\", \"templates\", \"UD_module_components.R\"), \"UD_module_components.R\") runApp(system.file(package=\"formods\", \"templates\", \"UD_module_components.R\"))"},{"path":"/articles/included_modules.html","id":"compact-ui-elements","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"Compact UI elements","title":"Included Modules","text":"Using module components script , can see whate UI element looks like behaves. allows granular control UI elements placement. module, formods provides single ui output place module UI components together. upload data module looks like : copy FM_compact.R file locally, can see used module: can run example see modules interact well:","code":"htmlOutput(NS(\"UD\", \"ui_ud_compact\")) copy.file(system.file(package=\"formods\", \"templates\", \"FM_compact.R\"), \"FM_compact.R\") runApp(system.file(package=\"formods\", \"templates\", \"FM_compact.R\"))"},{"path":"/articles/included_modules.html","id":"deployment","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"Deployment","title":"Included Modules","text":"deploy App need create App file appropriate ui server functions called App.R. create one : certain aspects app behave differently deployed. need indicate app deployed. can two ways. done setting deployed argument server functions TRUE.","code":"file.copy(from = system.file(package=\"formods\", \"templates\", \"FM_compact.R\"), to = \"App.R\")"},{"path":"/articles/included_modules.html","id":"server-functions","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"Server functions","title":"Included Modules","text":"module server function uses shortname followed underscore prefix. example server function named using convention: XX_Server(). XX module short name. example server function upload data module UD_Server(). minimum server take module ID, configuration file formods package, module configuration file, reactive object called react_state. react_state object used link reactions modules. different XX_module_components.R files shows use server functions module. Briefly, using UD module example following app server function:","code":"server <- function(input, output, session) { react_FM = reactiveValues() # Module server UD_Server(id=\"UD\", react_state=react_FM) }"},{"path":"/articles/included_modules.html","id":"yaml-configuration-files","dir":"Articles","previous_headings":"Avialable modules > Using a module","what":"YAML configuration files","title":"Included Modules","text":"formods individual modules configured YAML files. default, modules use included template YAML files. However, may want alter default formatting text. simply need make local copies files like : can modify files. use need point server functions instead default templates. following sections describe current modules use .","code":"copy.file(system.file(package=\"formods\", \"templates\", \"formods.yaml\"), \"formods.yaml\") copy.file(system.file(package=\"formods\", \"templates\", \"UD.yaml\"), \"UD.yaml\")"},{"path":"/articles/included_modules.html","id":"app-state-management-asm","dir":"Articles","previous_headings":"Avialable modules","what":"App State Management (ASM)","title":"Included Modules","text":"ASM module used manage app state. allows user save current app state load later time.","code":""},{"path":"/articles/included_modules.html","id":"upload-data-ud","dir":"Articles","previous_headings":"Avialable modules","what":"Upload Data (UD)","title":"Included Modules","text":"UD module allows users upload data files App. allow specify file types Excel files sheet used. Provides Data sets via: FM_fetch_ds()","code":""},{"path":"/articles/included_modules.html","id":"data-wrangling-dw","dir":"Articles","previous_headings":"Avialable modules","what":"Data Wrangling (DW)","title":"Included Modules","text":"DW module provides interface dplyr tidyr.used create chains data wrangling commands user can build transform data creating data views. DW module can use data UD module, can take list dataset. Provides Data views via: FM_fetch_ds() Reporting data views (Excel)","code":""},{"path":"/articles/included_modules.html","id":"figure-generation-fg","dir":"Articles","previous_headings":"Avialable modules","what":"Figure Generation (FG)","title":"Included Modules","text":"FG module provides interface ggplot allows user select original data set UD module well data views created DW module. user can create multiple figures. Provides Reporting figures (PowerPoint Word)","code":""},{"path":[]},{"path":"/articles/included_modules.html","id":"request-entity-too-large-","dir":"Articles","previous_headings":"Known Issues","what":"413 Request Entity too large.","title":"Included Modules","text":"running RStudio server (web browser) receive following message: 413 Request Entity large. problem lies NGINX server. proxy server used RStudio. issue limit maximum upload size NGINX server. solution edit configuration file (something like /etc/nginx/nginx.conf) set option client_mx_body_size something reasonable.","code":""},{"path":[]},{"path":"/articles/making_modules.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Making Modules","text":"vignette provide overview formods framework creating reproducable modules interact . module namespace mantained using module short name prefix functions. example figure generation module uses FG. want create module, please submit issue formods github repository following information: short name intend use brief description module list modules depends ","code":""},{"path":"/articles/making_modules.html","id":"current-modules","dir":"Articles","previous_headings":"Introduction","what":"Current modules","title":"Making Modules","text":"ASM - App State Management DW - Data Wrangling FG - Figure Generation FM - Formods UD - Upload Data MC - reserved word current modules development: NCA - Non-Compartmental Analysis MB - Model Builder","code":""},{"path":"/articles/making_modules.html","id":"formods-framework","dir":"Articles","previous_headings":"","what":"formods framework","title":"Making Modules","text":"get started need create template files. example assumes creating module package called mypackage running command git repository. Say module used produce widgets, short name MM stands Module: MM_module_components.R - app can used testing module highlighting different UI elements used within module (found inst/templates). MM_Server.R: bare bones file containing expected functions minimal inputs. (found R). MM.yaml: module configuration file contains minimal elements expected, can add fields suit modules needs (found inst/templates).","code":"use_formods(SN = \"MM\", Module_Name = \"My Module\", element = \"widgets\", package = \"mypackage\")"},{"path":"/articles/making_modules.html","id":"expected-functions","dir":"Articles","previous_headings":"","what":"Expected functions","title":"Making Modules","text":"module template create standard set functions . MM replaced whatever short name choose create templates. functions can customized specific module. optional can deleted. example MM_fetch_ds function needed module creates datasets provides modules use (like DW module exports data views used modules). modules designed create elements. example DW module creates data view elements, FG module used create figure elements, etc. MM_Server Shiny server function. MM_init_state Creates empty formods state module. MM_fetch_state module function fetch state. Within function interactivity. access elements Shiny input isolated. Based differences input elements (current state app) stored app state can used trigger different things. MM_fetch_code takes ’s first argument module state. called argument return character object containing code needed generate elements module represented app. can assume modules one depends defined previously. example FG module return code associated generating figures. appended code UD DW modules define loading dataset creation data views. modules code generated (e.g. ASM) just return NULL. MM_append_report module generates reportable outputs, function used append outputs overall reports generated formods. hasds Boolean variable indicating modules currently exportable datasets. isgood General return status funciton. Set FALSE errors encoutered. msgs character vector messages pass back user. label Text label dataset MOD_TYPE Short name type module. id module ID. DS Dataframe containing actual dataset. DSMETA Metadata describing DS. code Complete code build dataset. checksum Module checksum. DSchecksum Dataset checksum. isgood Boolean indicating exit status function. session value Shiny session variable (app) list (outside app) initialization. input value shiny input end session initialization. state App state. rsc react_state components. MM_new_element Creates new module element. MM_fetch_current_element Extracts current element state object. MM_set_current_element Sets current element provided value. MM_del_element Deletes current active element.","code":""},{"path":"/articles/making_modules.html","id":"expected-ui-components","dir":"Articles","previous_headings":"","what":"Expected UI components","title":"Making Modules","text":"ui_mm_compact UI output contains compact view module can called main ui functions App. composed individual UI elements shown MM_module_components.R file. allows user quick way utilize model (using ui_mm_compact), ability customize module UI manually arranging pieces found MM_module_components.R.","code":""},{"path":"/articles/making_modules.html","id":"module-interaction","dir":"Articles","previous_headings":"","what":"Module interaction","title":"Making Modules","text":"Say using UD module feed data DW module user goes back upload form uploads different data set. need trigger reset Data Wrangling module well tell larger app something changed.","code":""},{"path":"/articles/making_modules.html","id":"module-state-and-reacting-to-changes","dir":"Articles","previous_headings":"Module interaction","what":"Module state and reacting to changes","title":"Making Modules","text":"Changes module states detected react_state object. given module type \"MM\" module id \"ID\" detect changes reacting react_state[[\"ID\"]] looking changes checksum element : react_state[[\"ID\"]][[\"MM\"]][[\"checksum\"]] checksum checksum can used detect changes module. example UD module change uploaded file sheet selected currently uplo:waded file changes.","code":""},{"path":"/articles/making_modules.html","id":"helper-functions-in-formods","dir":"Articles","previous_headings":"","what":"Helper functions in formods","title":"Making Modules","text":"FM_le() - Creates log entries (le) displayed console. FM_tc() - can used evaluate code, trap errors, process results. has_changed() set_hold() - Used set hold one UI elements. prevents internal updating UI element based current value App. fetch_hold() - retrieve hold status UI element. remove_hold() - remove holds set UI element. ‘FM_build_comment()’ - creates comments strings form sections viewed RStudio. FM_add_ui_tooltip() - Attaches tooltip UI element. FM_init_state() - Called top module state initialization function create skeleton module state can build upon. FM_set_notification() - Within code can create notifications attach module state. FM_notify() - Used observeEvent() show notifications yet displayed. FM_set_mod_state() FM_fetch_mod_state() FM_set_ui_msg() FM_pretty_sort() - Used general sorting function try make sorted results prettier. FM_pause_screen() - Pauses screen something server side takes . FM_resume_screen() - Resumes activity (unpauses screen) ’re done pause. FM_fetch_data_format() - Creates formatting information display given data frame. examples require Shiny session variable formods state object. create examples objects needed demonstrate functions .","code":"library(formods) # This creates the state and session objects sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state session = sess_res$session # Here we load an example dataset into the df object. data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") sheet = \"DATA\" df = readxl::read_excel(path=data_file_local, sheet=sheet)"},{"path":"/articles/making_modules.html","id":"setting-holds-on-ui-elements","dir":"Articles","previous_headings":"Helper functions in formods","what":"Setting holds on UI elements","title":"Making Modules","text":"mechanics fetch state functions mean time fetch state called, UI elements App pulled placed app state. generally works well exceptions. main exception want UI element changes another UI element. Say example selection box UI id my_selection. want selection alter text input id my_text. However just poll ui elements may update my_text based changes my_selection overwritten current value my_text. prevent , need two things: processing my_selection need set hold my_text (done set_hold()). processing my_text need hold set. checked fetch_hold() Lastly need remove hold. done UI refreshed new text value populated my_text (appropriate reactions set). done observeEvent triggered everything else (priority -100 ): remove_hold_listen object contain inputs create holds.","code":"remove_hold_listen <- reactive({ list(input$my_selection) }) observeEvent(remove_hold_listen(), { # Once the UI has been regenerated we # remove any holds for this module state = MM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, react_state = react_state) FM_le(state, \"removing holds\") # Removing all holds for(hname in names(state[[\"MM\"]][[\"ui_hold\"]])){ remove_hold(state, session, hname) } }, priority = -100)"},{"path":"/articles/making_modules.html","id":"dataframe-formatting-information","dir":"Articles","previous_headings":"Helper functions in formods","what":"Dataframe formatting information","title":"Making Modules","text":"want tables pulldown menues based types data column can use FM_fetch_data_format() function. custom headers can used rhandsontable package. add subtext selection widget Shiny need use shinyWidgets package. alter formats shown need edit formods.yaml configuration file look FM\\(\\rightarrow\\)data_meta section.","code":"hfmt = FM_fetch_data_format(df, state) # Descriptive headers head(as.vector(unlist( hfmt[[\"col_heads\"]]))) #> [1] \"<span style='color:#3C8DBC'><b>ID<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [2] \"<span style='color:#3C8DBC'><b>TIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [3] \"<span style='color:#3C8DBC'><b>TIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [4] \"<span style='color:#3C8DBC'><b>NTIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [5] \"<span style='color:#3C8DBC'><b>NTIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [6] \"<span style='color:#3C8DBC'><b>TIME<\/b><br/><font size='-3'>num<\/font><\/span>\" # Subtext head(as.vector(unlist( hfmt[[\"col_subtext\"]]))) #> [1] \"num: 1,⋅⋅⋅,360\" \"num: 0,⋅⋅⋅,84\" \"num: 0,⋅⋅⋅,2016\" \"num: 0,⋅⋅⋅,42\" #> [5] \"num: 0,⋅⋅⋅,1008\" \"num: 0,⋅⋅⋅,2016\" hot = rhandsontable::rhandsontable( head(df), width = \"100%\", height = \"100%\", colHeaders = as.vector(unlist(hfmt[[\"col_heads\"]])), rowHeaders = NULL ) sel_subtext = as.vector(unlist( hfmt[[\"col_subtext\"]])) library(shinyWidgets) shinyWidgets::pickerInput( inputId = \"select_example\", choices = names(df), label = \"Select with subtext\", choicesOpt = list(subtext = sel_subtext))"},{"path":"/articles/making_modules.html","id":"notifications","dir":"Articles","previous_headings":"Helper functions in formods","what":"Notifications","title":"Making Modules","text":"Notifications created using shinybusy package produced two different functions: FM_set_notification() FM_notify(). done centralized fashion notifications added state object user information processed. set notification called Example Notification. Along timestamp set: timestamp used track prevent notification shown multiple times. Next need setup reactions display notifications. can create reactive expression inputs lead notification: Next use observeEvent() reactive expression trigger notifications. need use fetch state function molecule get state object notifications. FM_notify() called unprocessed notifications displayed:","code":"state = FM_set_notification(state, \"Something happened\", \"Example Notification\") toNotify <- reactive({ list(input$input1, input$input2) }) observeEvent(toNotify(), { state = MM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, react_state = react_state) # Triggering optional notifications notify_res = FM_notify(state = state, session = session) })"},{"path":"/articles/making_modules.html","id":"adding-tooltips","dir":"Articles","previous_headings":"Helper functions in formods","what":"Adding tooltips","title":"Making Modules","text":"Tooltips created interally using suggested prompter package. add tool tip ui element use FM_add_ui_tooltip() function. example add tool tip, need type harder! text input following:","code":"uiele = shiny::textInput( inputId = \"some_text\", label = \"You need to type harder!\") uiele = FM_add_ui_tooltip(state, uiele, tooltip = \"This is a tooltip\", position = \"left\")"},{"path":"/articles/making_modules.html","id":"pausing-the-screen","dir":"Articles","previous_headings":"Helper functions in formods","what":"Pausing the screen","title":"Making Modules","text":"pause screen shinybusy package also used. controlled two functions: FM_pause_screen() used pause screen /update pause message, FM_resume_screen() used end pause resume interaction user.","code":"FM_pause_screen(state, session) FM_resume_screen(state, session)"},{"path":"/articles/making_modules.html","id":"formods-state-objects","dir":"Articles","previous_headings":"","what":"formods state objects","title":"Making Modules","text":"create formods state object can following fields: yaml- Contents formods configuration file. MC - Contents module configuration file. MM - MM short name current module. MOD_TYPE ), store app information. (see ). MOD_TYPE - Short name module. id - ID module. FM_yaml_file - formods configuration file. MOD_yaml_file - Module configuration file. notifications - Contains notifications set user FM_set_notification().","code":""},{"path":"/articles/making_modules.html","id":"app-information-in-mm","dir":"Articles","previous_headings":"formods state objects","what":"App information in MM","title":"Making Modules","text":"field state$MM relatively free form reserved elements. reserved keyword : button_counters - Counter tracks button clicks ui_hold - List hold elements populated set_hold() isgood - Boolean variable indicating state module. ui_msg - Messaages returned UI captured errors populated FM_set_ui_msg() fields can store whatever else need module.","code":""},{"path":[]},{"path":"/articles/making_modules.html","id":"yaml-configuration-files","dir":"Articles","previous_headings":"","what":"YAML configuration files","title":"Making Modules","text":"","code":"# https://www.glyphicons.com/sets/basic/ #General formods (FM) configuration across modules FM: include: files: - file: source: 'file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\")' dest: 'file.path(\"config\",\"report.docx\")' - file: source: 'file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\")' dest: 'file.path(\"config\",\"report.pptx\")' - file: source: 'file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\")' dest: 'file.path(\"config\",\"report.yaml\")' # Some features (e.g. copy to clipboard) don't work when deployed deployed: FALSE #General code options for the modules code: theme: \"vibrant_ink\" showLineNumbers: TRUE # File name of the R script to contain generation code gen_file: run_analysis.R # This is the preamble used in script generation. It goes on the # top. Feel free to add to it if you need to. Note that packages should be # listed in the packages section at the same level. gen_preamble: |- # formods automated output ------------------------------------------------ # https://formods.ubiquity.tools/ rm(list=ls()) # Each module should have a packages section that lists the packages # needed for code genereated for that module. packages: [\"onbrand\", \"writexl\"] notifications: config: # You can put any arguments here that would be arguments for # config_notify(). See ?shinybusy::config_notify() for more information success: useFontAwesome: FALSE useIcon: FALSE background: \"#5bb85b\" failure: useFontAwesome: FALSE useIcon: FALSE background: \"#d9534f\" info: useFontAwesome: FALSE useIcon: FALSE background: \"#5bc0de\" warning: useFontAwesome: FALSE useIcon: FALSE background: \"#f0ac4d\" reporting: # enabled here controls reporting for the app. Individual modules can be # controlled in their respective configuration files enabled: TRUE # The content_init section is used to initialize reports. You shouldn't # change the xlsx rpt but the docx and pptx rpt can be altered to # use custom onbrand templates. The main thing is that you create an # object called rpt with the appropriate template type in it. You can # also do any preprocessing here as well such as adding default content or # doing any placeholder assignments you might want to use. The paths can # be absolute paths. If relative paths are used they will be relative to # the user directory (either the temp formods directory running in shiny # or the top level of the zip file structure when saving the app state). content_init: xlsx: |- rpt = list(summary = NULL, sheets = list()) docx: |- rpt = onbrand::read_template( template = file.path(\"config\", \"report.docx\"), mapping = file.path(\"config\", \"report.yaml\")) pptx: |- rpt = onbrand::read_template( template = file.path(\"config\", \"report.pptx\"), mapping = file.path(\"config\", \"report.yaml\")) ui: # See ?actionBttn for styles button_style: \"fill\" # Max size for picker inputs select_size: 10 color_green: \"#00BB8A\" color_red: \"#FF475E\" color_blue: \"#0088FF\" color_purple: \"#bd2cf4\" data_meta: # This controls the overall format of headers and the select subtext for # data frames with the following placeholders surrouned by ===: # COLOR - font color # NAME - colum name # LABEL - type label # RANGE - this depends on the nature of the data in the column: # - If there are between 1 and 3 values then those values are shown. # - If there are more than 3 values then the min and max are show. data_header: \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" subtext: \"===LABEL===: ===RANGE===\" # Separator when showing more than three in a column. For exmaple if you # had a dataset with 1,2,3,4,5,6 and many_sep was \",...,\" then it would # appear as \"1,...,6\" many_sep: \",⋅⋅⋅,\" # This controls the differences for different data types. Take the output # of typeof(df$colname) and put an entry for that output here. data_types: character: color: \"#DD4B39\" label: \"text\" double: color: \"#3C8DBC\" label: \"num\" integer: color: \"#3C8DBC\" label: \"num\" other: color: \"black\" label: \"other\" labels: # JMH remove this once the datset stuff has been moved over default_ds: \"Original data set\" user_files: use_tmpdir: TRUE logging: enabled: TRUE timestamp: TRUE timestamp_fmt: \"%Y-%m-%d %H:%M:%S\" log_file: \"formods_log.txt\" console: TRUE"},{"path":"/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"John Harrold. Author, maintainer.","code":""},{"path":"/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Harrold J (2023). formods: 'Shiny' Modules General Tasks. R package version 0.1.2, https://formods.ubiquity.tools/.","code":"@Manual{, title = {formods: 'Shiny' Modules for General Tasks}, author = {John Harrold}, year = {2023}, note = {R package version 0.1.2}, url = {https://formods.ubiquity.tools/}, }"},{"path":"/index.html","id":"formods-","dir":"","previous_headings":"","what":"Shiny Modules for General Tasks","title":"Shiny Modules for General Tasks","text":"Shiny apps can often make use key elements, formods provides modules common tasks (data upload, wragling data, figure genration saving app state). modules can react interact well generate code create reproducable analyses. formods also defines framework creating reactive modules. vignettes outline use modules well create modules within framework.","code":""},{"path":[]},{"path":"/index.html","id":"from-cran","dir":"","previous_headings":"","what":"From CRAN","title":"Shiny Modules for General Tasks","text":"can install released version formods CRAN :","code":"install.packages(\"formods\")"},{"path":"/index.html","id":"development-version","dir":"","previous_headings":"","what":"Development version","title":"Shiny Modules for General Tasks","text":"can install development version GitHub : Note formods depends onbrand need first install development version onbrand.","code":"# Installing devtools if it's not already installed if(system.file(package=\"devtools\") == \"\"){ install.packages(\"devtools\") } devtools::install_github(\"john-harrold/onbrand\", dependencies=TRUE) devtools::install_github(\"john-harrold/formods\", dependencies=TRUE)"},{"path":"/index.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting started","title":"Shiny Modules for General Tasks","text":"","code":"library(shiny) library(formods) runApp(system.file(package=\"formods\", \"templates\",\"FM_compact.R\"))"},{"path":"/reference/ASM_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Save State Server — ASM_Server","title":"Save State Server — ASM_Server","text":"Server function Save State Shiny Module","code":""},{"path":"/reference/ASM_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save State Server — ASM_Server","text":"","code":"ASM_Server( id, FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\"), deployed = FALSE, react_state = NULL, mod_ids )"},{"path":"/reference/ASM_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save State Server — ASM_Server","text":"id ID string corresponds ID used call modules UI elements FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL) mod_ids Vector module IDs order needed (used code generation).","code":""},{"path":"/reference/ASM_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Save State Server — ASM_Server","text":"UD Server object","code":""},{"path":"/reference/ASM_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Save State Server — ASM_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/ASM_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — ASM_fetch_code","title":"Fetch Module Code — ASM_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/ASM_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — ASM_fetch_code","text":"","code":"ASM_fetch_code(state)"},{"path":"/reference/ASM_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — ASM_fetch_code","text":"state ASM state ASM_fetch_state()","code":""},{"path":"/reference/ASM_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — ASM_fetch_code","text":"ASM module generate code","code":""},{"path":"/reference/ASM_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — ASM_fetch_code","text":"","code":"# Creating a state object for testing sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized state = sess_res$state code = ASM_fetch_code(state)"},{"path":"/reference/ASM_fetch_dlfn.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Download File Name — ASM_fetch_dlfn","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"Gets either file name specified user default value null","code":""},{"path":"/reference/ASM_fetch_dlfn.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"","code":"ASM_fetch_dlfn(state, extension = \".zip\")"},{"path":"/reference/ASM_fetch_dlfn.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"state ASM state ASM_fetch_state() extension File extension download (default: \".zip\")","code":""},{"path":"/reference/ASM_fetch_dlfn.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"character object download file name","code":""},{"path":"/reference/ASM_fetch_dlfn.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Download File Name — ASM_fetch_dlfn","text":"","code":"# Creating a state object for testing sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized state = sess_res$state dlfn = ASM_fetch_dlfn(state) dlfn #> [1] \"Save Analysis.zip\""},{"path":"/reference/ASM_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch State Manager State — ASM_fetch_state","title":"Fetch State Manager State — ASM_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/ASM_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch State Manager State — ASM_fetch_state","text":"","code":"ASM_fetch_state(id, input, session, FM_yaml_file, MOD_yaml_file)"},{"path":"/reference/ASM_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch State Manager State — ASM_fetch_state","text":"id Shiny module ID input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section.","code":""},{"path":"/reference/ASM_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch State Manager State — ASM_fetch_state","text":"list containing current state app including default values yaml file well changes made user. list following structure: yaml: Full contents supplied yaml file. MC: Module components yaml file. ASM: isgood: Boolean object indicating file successfully loaded. checksum: MD5 sum loaded state file MOD_TYPE: Character data containing type module \"ASM\" id: Character data containing module id module session variable. FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section.","code":""},{"path":"/reference/ASM_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch State Manager State — ASM_fetch_state","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized session = sess_res$session input = sess_res$input # Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\") # We need to specify the ID of the ASM module id = \"ASM\" state = ASM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file) state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$code #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> #> $MC$show_log #> [1] 50 #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$formatting #> $MC$formatting$input_load_state #> $MC$formatting$input_load_state$width #> [1] \"100%\" #> #> #> $MC$formatting$ui_asm_save_name #> $MC$formatting$ui_asm_save_name$width #> [1] \"100%\" #> #> #> $MC$formatting$button_state_save #> $MC$formatting$button_state_save$size #> [1] \"sm\" #> #> $MC$formatting$button_state_save$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_xlsx #> $MC$formatting$button_rpt_xlsx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_xlsx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_pptx #> $MC$formatting$button_rpt_pptx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_pptx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_docx #> $MC$formatting$button_rpt_docx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_docx$block #> [1] TRUE #> #> #> $MC$formatting$switch_gen_reports #> $MC$formatting$switch_gen_reports$default #> [1] FALSE #> #> $MC$formatting$switch_gen_reports$right #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$inline #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$width #> NULL #> #> #> #> $MC$labels #> $MC$labels$ui_asm_save_name #> [1] \"Save Analysis\" #> #> $MC$labels$ui_asm_save_name_ph #> [1] \"my_analysis\" #> #> $MC$labels$ui_asm_switch_gen_rpts #> [1] \"Generate reports when saving.\" #> #> $MC$labels$save_state #> [1] \"Save\" #> #> $MC$labels$input_load_state #> [1] \"Load Analysis\" #> #> $MC$labels$upload_button #> [1] \"Load\" #> #> $MC$labels$upload_placeholder #> [1] \"Select analysis file\" #> #> $MC$labels$ui_asm_rpt_xlsx #> [1] \"xlsx\" #> #> $MC$labels$ui_asm_rpt_pptx #> [1] \"pptx\" #> #> $MC$labels$ui_asm_rpt_docx #> [1] \"docx\" #> #> $MC$labels$busy #> $MC$labels$busy$saving_state #> [1] \"Saving app state\" #> #> $MC$labels$busy$xlsx #> [1] \"Generating report: Excel\" #> #> $MC$labels$busy$docx #> [1] \"Generating report: Word\" #> #> $MC$labels$busy$pptx #> [1] \"Generating report: PowerPoint\" #> #> #> #> $MC$errors #> $MC$errors$bad_input #> [1] \"Input error message\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$input_tip #> [1] \"My tool tip\" #> #> #> #> #> $ASM #> $ASM$button_counters #> $ASM$button_counters$button_state_save #> [1] 0 #> #> $ASM$button_counters$button_rpt_xlsx #> [1] 0 #> #> $ASM$button_counters$button_rpt_docx #> [1] 0 #> #> $ASM$button_counters$button_rpt_pptx #> [1] 0 #> #> #> $ASM$ui_hold #> list() #> #> $ASM$ui_ids #> [1] \"button_state_save\" \"button_rpt_xlsx\" \"button_rpt_docx\" #> [4] \"button_rpt_pptx\" \"ui_asm_save_name\" \"switch_gen_rpts\" #> #> $ASM$isgood #> [1] TRUE #> #> $ASM$checksum #> [1] \"f9e884084b84794d762a535f3facec85\" #> #> $ASM$ui #> $ASM$ui$button_state_save #> [1] \"\" #> #> $ASM$ui$button_rpt_xlsx #> [1] \"\" #> #> $ASM$ui$button_rpt_docx #> [1] \"\" #> #> $ASM$ui$button_rpt_pptx #> [1] \"\" #> #> $ASM$ui$ui_asm_save_name #> [1] \"\" #> #> $ASM$ui$switch_gen_rpts #> [1] \"\" #> #> #> #> $MOD_TYPE #> [1] \"ASM\" #> #> $id #> [1] \"ASM\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ASM.yaml\" #>"},{"path":"/reference/ASM_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize ASM Module State — ASM_init_state","title":"Initialize ASM Module State — ASM_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/ASM_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize ASM Module State — ASM_init_state","text":"","code":"ASM_init_state(FM_yaml_file, MOD_yaml_file, id, session)"},{"path":"/reference/ASM_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize ASM Module State — ASM_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id ID string module. session Shiny session variable","code":""},{"path":"/reference/ASM_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize ASM Module State — ASM_init_state","text":"list containing empty ASM state","code":""},{"path":"/reference/ASM_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize ASM Module State — ASM_init_state","text":"","code":"# Within shiny the session variable will exist, # this creates an example here for testing purposes: sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized session = sess_res$session state = ASM_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\"), id = \"ASM\", session = session) #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$code #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> #> $MC$show_log #> [1] 50 #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$formatting #> $MC$formatting$input_load_state #> $MC$formatting$input_load_state$width #> [1] \"100%\" #> #> #> $MC$formatting$ui_asm_save_name #> $MC$formatting$ui_asm_save_name$width #> [1] \"100%\" #> #> #> $MC$formatting$button_state_save #> $MC$formatting$button_state_save$size #> [1] \"sm\" #> #> $MC$formatting$button_state_save$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_xlsx #> $MC$formatting$button_rpt_xlsx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_xlsx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_pptx #> $MC$formatting$button_rpt_pptx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_pptx$block #> [1] TRUE #> #> #> $MC$formatting$button_rpt_docx #> $MC$formatting$button_rpt_docx$size #> [1] \"sm\" #> #> $MC$formatting$button_rpt_docx$block #> [1] TRUE #> #> #> $MC$formatting$switch_gen_reports #> $MC$formatting$switch_gen_reports$default #> [1] FALSE #> #> $MC$formatting$switch_gen_reports$right #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$inline #> [1] TRUE #> #> $MC$formatting$switch_gen_reports$width #> NULL #> #> #> #> $MC$labels #> $MC$labels$ui_asm_save_name #> [1] \"Save Analysis\" #> #> $MC$labels$ui_asm_save_name_ph #> [1] \"my_analysis\" #> #> $MC$labels$ui_asm_switch_gen_rpts #> [1] \"Generate reports when saving.\" #> #> $MC$labels$save_state #> [1] \"Save\" #> #> $MC$labels$input_load_state #> [1] \"Load Analysis\" #> #> $MC$labels$upload_button #> [1] \"Load\" #> #> $MC$labels$upload_placeholder #> [1] \"Select analysis file\" #> #> $MC$labels$ui_asm_rpt_xlsx #> [1] \"xlsx\" #> #> $MC$labels$ui_asm_rpt_pptx #> [1] \"pptx\" #> #> $MC$labels$ui_asm_rpt_docx #> [1] \"docx\" #> #> $MC$labels$busy #> $MC$labels$busy$saving_state #> [1] \"Saving app state\" #> #> $MC$labels$busy$xlsx #> [1] \"Generating report: Excel\" #> #> $MC$labels$busy$docx #> [1] \"Generating report: Word\" #> #> $MC$labels$busy$pptx #> [1] \"Generating report: PowerPoint\" #> #> #> #> $MC$errors #> $MC$errors$bad_input #> [1] \"Input error message\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$input_tip #> [1] \"My tool tip\" #> #> #> #> #> $ASM #> $ASM$button_counters #> $ASM$button_counters$button_state_save #> [1] 0 #> #> $ASM$button_counters$button_rpt_xlsx #> [1] 0 #> #> $ASM$button_counters$button_rpt_docx #> [1] 0 #> #> $ASM$button_counters$button_rpt_pptx #> [1] 0 #> #> #> $ASM$ui_hold #> list() #> #> $ASM$ui_ids #> [1] \"button_state_save\" \"button_rpt_xlsx\" \"button_rpt_docx\" #> [4] \"button_rpt_pptx\" \"ui_asm_save_name\" \"switch_gen_rpts\" #> #> $ASM$isgood #> [1] TRUE #> #> $ASM$checksum #> [1] \"f9e884084b84794d762a535f3facec85\" #> #> #> $MOD_TYPE #> [1] \"ASM\" #> #> $id #> [1] \"ASM\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ASM.yaml\" #>"},{"path":"/reference/ASM_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — ASM_test_mksession","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/ASM_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"","code":"ASM_test_mksession( session, id = \"ASM\", id_UD = \"UD\", id_DW = \"DW\", id_FG = \"FG\", full_session = TRUE )"},{"path":"/reference/ASM_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements id_UD ID string corresponds ID used call UD modules UI elements id_DW ID string corresponds ID used call DW modules UI elements id_FG ID string corresponds ID used call FG modules UI elements full_session Boolean indicate full test session created (default TRUE).","code":""},{"path":"/reference/ASM_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/ASM_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — ASM_test_mksession","text":"","code":"sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized"},{"path":"/reference/ASM_write_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Write State to File for Saving — ASM_write_state","title":"Write State to File for Saving — ASM_write_state","text":"Called download handler used write saved state value null","code":""},{"path":"/reference/ASM_write_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write State to File for Saving — ASM_write_state","text":"","code":"ASM_write_state(state, session, file, mod_ids)"},{"path":"/reference/ASM_write_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write State to File for Saving — ASM_write_state","text":"state ASM state ASM_fetch_state() session Shiny session variable file File name write zipped state. mod_ids Vector module IDs order needed (used code generation).","code":""},{"path":"/reference/ASM_write_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Write State to File for Saving — ASM_write_state","text":"function writes state return value.","code":""},{"path":"/reference/ASM_write_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Write State to File for Saving — ASM_write_state","text":"","code":"# \\donttest{ # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = ASM_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → ASM: dest: file.path(\"config\",\"report.docx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → ASM: dest: file.path(\"config\",\"report.pptx\") #> → ASM: including file #> → ASM: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → ASM: dest: file.path(\"config\",\"report.yaml\") #> → ASM: State initialized session = sess_res$session input = sess_res$input # Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"ASM.yaml\") # We need to specify the ID of the ASM module id = \"ASM\" state = ASM_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file) ASM_write_state(state, session, file = tempfile(fileext=\".zip\"), mod_ids = c(\"UD\")) #> → ASM: writing app state to file on server: #> → ASM: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/file6d9dd82030e.zip #> → ASM: Generating reports (code only) #> → ASM: Generating report: xlsx #> → ASM: appending report for module:DW id:DW priority:1 #> → ASM: appending report for module:FG id:FG priority:1 #> → ASM: Generating report: pptx #> → ASM: appending report for module:DW id:DW priority:1 #> → ASM: appending report for module:FG id:FG priority:1 #> → ASM: Generating report: docx #> → ASM: appending report for module:DW id:DW priority:1 #> → ASM: appending report for module:FG id:FG priority:1 #> → ASM: done writing app state #> NULL # }"},{"path":"/reference/DW_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Data Wrangling Server — DW_Server","title":"Data Wrangling Server — DW_Server","text":"Server function data wrangling module","code":""},{"path":"/reference/DW_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Data Wrangling Server — DW_Server","text":"","code":"DW_Server( id, id_ASM = \"ASM\", id_UD = \"UD\", FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"DW.yaml\"), deployed = FALSE, react_state = NULL )"},{"path":"/reference/DW_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Data Wrangling Server — DW_Server","text":"id ID string corresponds ID used call modules UI elements id_ASM ID string app state managment module used save load app states id_UD ID string upload data module used handle uploads name list element react_state data set stored. FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file DW main section. deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/DW_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Data Wrangling Server — DW_Server","text":"DW Server object","code":""},{"path":"/reference/DW_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Data Wrangling Server — DW_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/DW_add_wrangling_element.html","id":null,"dir":"Reference","previous_headings":"","what":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"Adds wrangling element current data view.","code":""},{"path":"/reference/DW_add_wrangling_element.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"","code":"DW_add_wrangling_element(state, dwb_res, dwee_res)"},{"path":"/reference/DW_add_wrangling_element.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"state DW state DW_fetch_state() dwb_res Output dwrs_builder() dwee_res Output dw_eval_element() returned UD_fetch_state().","code":""},{"path":"/reference/DW_add_wrangling_element.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"state data set attached","code":""},{"path":"/reference/DW_add_wrangling_element.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Adding Wrangling Element to Current Data View — DW_add_wrangling_element","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_append_report.html","id":null,"dir":"Reference","previous_headings":"","what":"Append Report Elements — DW_append_report","title":"Append Report Elements — DW_append_report","text":"Takes current state app appends data views xlsx report object.","code":""},{"path":"/reference/DW_append_report.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Append Report Elements — DW_append_report","text":"","code":"DW_append_report(state, rpt, rpttype, gen_code_only = FALSE)"},{"path":"/reference/DW_append_report.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Append Report Elements — DW_append_report","text":"state DW state DW_fetch_state() rpt Report current content report appended function. details structure see documentation FM_generate_report. rpttype Type report generate (supported \"xlsx\"). gen_code_only Boolean value indicating code generated (FALSE).","code":""},{"path":"/reference/DW_append_report.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Append Report Elements — DW_append_report","text":"list containing following elements isgood: Return status function. hasrptele: Boolean indicator module reportable elements. code: Code generate reporting elements. msgs: Messages passed back user. rpt: Report additions passed back user.","code":""},{"path":[]},{"path":"/reference/DW_append_report.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Append Report Elements — DW_append_report","text":"","code":"# We need a state object to use below sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state = sess_res$state rpt = list(summary = list(), sheets=list()) rpt_res = DW_append_report(state, rpt = rpt, rpttype = \"xlsx\") # Shows if report elements are present rpt_res$hasrptele #> [1] TRUE # Code chunk to generate report element cat(paste(rpt_res$code, collapse=\"\\n\")) #> rpt[[\"sheets\"]][[\"DW_myDS_1\"]]=DW_myDS_1 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_1\", #> Description=\"Observations\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_2\"]]=DW_myDS_2 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_2\", #> Description=\"PK 3mg SD IV\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_3\"]]=DW_myDS_3 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_3\", #> Description=\"PK 3mg MD SC (first dose)\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_4\"]]=DW_myDS_4 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_4\", #> Description=\"Parameters\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_5\"]]=DW_myDS_5 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_5\", #> Description=\"PK/PD 3mg SD IV w/BQL\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_6\"]]=DW_myDS_6 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_6\", #> Description=\"PK/PD 3mg MD SC (first dose) w/BQL\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_7\"]]=DW_myDS_7 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_7\", #> Description=\"PK 3mg SD IV w/BQL\" #> ) #> ) #> rpt[[\"sheets\"]][[\"DW_myDS_8\"]]=DW_myDS_8 #> rpt[[\"summary\"]] = rbind(rpt[[\"summary\"]], #> data.frame( #> Sheet_Name=\"DW_myDS_8\", #> Description=\"PK 3mg SD IV w/BQL w/dosing\" #> ) #> ) # Tabular summary of data views rpt_res$rpt$summary #> Sheet_Name Description #> 1 DW_myDS_1 Observations #> 2 DW_myDS_2 PK 3mg SD IV #> 3 DW_myDS_3 PK 3mg MD SC (first dose) #> 4 DW_myDS_4 Parameters #> 5 DW_myDS_5 PK/PD 3mg SD IV w/BQL #> 6 DW_myDS_6 PK/PD 3mg MD SC (first dose) w/BQL #> 7 DW_myDS_7 PK 3mg SD IV w/BQL #> 8 DW_myDS_8 PK 3mg SD IV w/BQL w/dosing"},{"path":"/reference/DW_attach_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Attach Data Set to DW State — DW_attach_ds","title":"Attach Data Set to DW State — DW_attach_ds","text":"Attaches dataset DW state supplied.","code":""},{"path":"/reference/DW_attach_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attach Data Set to DW State — DW_attach_ds","text":"","code":"DW_attach_ds(state, id_UD, session)"},{"path":"/reference/DW_attach_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attach Data Set to DW State — DW_attach_ds","text":"state DW state DW_fetch_state() id_UD ID string upload data module used handle uploads session Shiny session variable","code":""},{"path":"/reference/DW_attach_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attach Data Set to DW State — DW_attach_ds","text":"state data set attached","code":""},{"path":"/reference/DW_attach_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attach Data Set to DW State — DW_attach_ds","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # We also need a state variable state = sess_res$state # We need to identify the UD module with the data id_UD = \"UD\" state = DW_attach_ds(state, id_UD, session)"},{"path":"/reference/DW_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — DW_fetch_code","title":"Fetch Module Code — DW_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/DW_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — DW_fetch_code","text":"","code":"DW_fetch_code(state)"},{"path":"/reference/DW_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — DW_fetch_code","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — DW_fetch_code","text":"Character object vector lines code isgood)","code":""},{"path":"/reference/DW_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — DW_fetch_code","text":"","code":"# This will create a formods DW state object for the example sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state = sess_res$state code = DW_fetch_code(state) cat(code) #> # Observations ============================================================ #> DW_myDS_1 = myDS #> DW_myDS_1 = dplyr::filter(DW_myDS_1,EVID == 0) #> DW_myDS_1 = dplyr::filter(DW_myDS_1,DV != 0) #> DW_myDS_1 = dplyr::mutate(DW_myDS_1,IDCMT = paste0(ID, ', ', CMT)) #> #> # PK 3mg SD IV ============================================================ #> DW_myDS_2 = myDS #> DW_myDS_2 = dplyr::filter(DW_myDS_2,EVID == 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,DV != 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg MD SC (first dose) =============================================== #> DW_myDS_3 = myDS #> DW_myDS_3 = dplyr::filter(DW_myDS_3,EVID == 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DV != 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DOSE_NUM == 1) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,CMT %in% c(\"C_ng_ml\")) #> #> # Parameters ============================================================== #> DW_myDS_4 = myDS #> DW_myDS_4 = dplyr::group_by(DW_myDS_4,ID) #> DW_myDS_4 = dplyr::filter(DW_myDS_4,row_number()==1) #> DW_myDS_4 = dplyr::select(DW_myDS_4,ID, DOSE, DOSE_STR, Cohort, ROUTE, ka, CL, Vc, Vp, Q) #> DW_myDS_4 = tidyr::pivot_longer(DW_myDS_4, cols = c(\"ka\", \"CL\", \"Vc\", \"Vp\", \"Q\"), names_to = \"parameter\", values_to = \"values\") #> #> # PK/PD 3mg SD IV w/BQL =================================================== #> DW_myDS_5 = myDS #> DW_myDS_5 = dplyr::filter(DW_myDS_5,EVID == 0) #> DW_myDS_5 = dplyr::filter(DW_myDS_5,Cohort %in% c(\"SD 3 mg IV\")) #> #> # PK/PD 3mg MD SC (first dose) w/BQL ====================================== #> DW_myDS_6 = myDS #> DW_myDS_6 = dplyr::filter(DW_myDS_6,EVID == 0) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,DOSE_NUM == 1) #> #> # PK 3mg SD IV w/BQL ====================================================== #> DW_myDS_7 = myDS #> DW_myDS_7 = dplyr::filter(DW_myDS_7,EVID == 0) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg SD IV w/BQL w/dosing ============================================= #> DW_myDS_8 = myDS #> DW_myDS_8 = dplyr::filter(DW_myDS_8,Cohort %in% c(\"MD 3 mg IV\"))"},{"path":"/reference/DW_fetch_current_view.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Current Data View — DW_fetch_current_view","title":"Fetches Current Data View — DW_fetch_current_view","text":"Takes DW state returns current active view","code":""},{"path":"/reference/DW_fetch_current_view.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Current Data View — DW_fetch_current_view","text":"","code":"DW_fetch_current_view(state)"},{"path":"/reference/DW_fetch_current_view.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Current Data View — DW_fetch_current_view","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_fetch_current_view.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Current Data View — DW_fetch_current_view","text":"List containing details active data view. structure list structure state$DW$views output DW_fetch_state().","code":""},{"path":"/reference/DW_fetch_current_view.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Current Data View — DW_fetch_current_view","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_fetch_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Datasets — DW_fetch_ds","title":"Fetch Module Datasets — DW_fetch_ds","text":"Fetches datasets contained module.","code":""},{"path":"/reference/DW_fetch_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Datasets — DW_fetch_ds","text":"","code":"DW_fetch_ds(state)"},{"path":"/reference/DW_fetch_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Datasets — DW_fetch_ds","text":"state UD state UD_fetch_state()","code":""},{"path":"/reference/DW_fetch_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Datasets — DW_fetch_ds","text":"Character object vector lines code list containing following elements isgood: Return status function. hasds: Boolean indicator module datasets msgs: Messages passed back user. ds: List datasets. list element name R-object dataset. element following structure: label: Text label dataset MOD_TYPE: Short name type module. id: module ID DS: Dataframe containing actual dataset. DSMETA: Metadata describing DS, see FM_fetch_ds() details format. code: Complete code build dataset. checksum: Module checksum. DSchecksum: Dataset checksum.","code":""},{"path":"/reference/DW_fetch_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Datasets — DW_fetch_ds","text":"","code":"# We need a state variable sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state = sess_res$state ds = DW_fetch_ds(state)"},{"path":"/reference/DW_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Data Wrangling State — DW_fetch_state","title":"Fetch Data Wrangling State — DW_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/DW_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Data Wrangling State — DW_fetch_state","text":"","code":"DW_fetch_state( id, input, session, FM_yaml_file, MOD_yaml_file, id_UD, react_state )"},{"path":"/reference/DW_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Data Wrangling State — DW_fetch_state","text":"id Shiny module ID input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id_UD ID string upload data module used handle uploads name list element react_state data set stored. react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/DW_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Data Wrangling State — DW_fetch_state","text":"List containing current state DM module including default values yaml file well changes made user. structure list defined . yaml: Contents yaml file. MC: Module components yaml file. DW: Data wrangling state isgood: Boolean status state. FALSE dataset identified id_UD bad. checksum: MD5 sum indicating change datasets within view. Use trigger updates respose changes module. button_counters: List counters detect button clicks. code_previous: Loading code UD field. current_view: View id current active data wrangling view. UD: Copy \"UD\" field id_UD react_state input. ui: Current value form elements UI ui_hold: List hold elements disable updates full ui referesh complete. view_cntr: Counter tracking view ids, value contains id last view created. views: List data wrangling views. view following structure: checksum: MD5 sum WDS code: Code generate WDS start finish code_dw_only: Code just wrangling portion. code_previous: Code load data assign view object. elements_table: Table data wrangling elements. id: Character id (view_idx) idx: Numeric id (1) isgood: Boolean status data view. False evaluation fails key: User key (short description) view_ds_object_name: Object name data view WDS: Current value data view successful commands elements_table evaluated. MOD_TYPE: Character data containing type module \"DW\" id: Character data containing module id FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section. module session variable.","code":""},{"path":"/reference/DW_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Data Wrangling State — DW_fetch_state","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"DW.yaml\") # We need to specify both the DW module id as well as the # id of the UD module that feeds into it. id = \"DW\" id_UD = \"UD\" # Creating an empty state object state = DW_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, id_UD = \"UD\", react_state = NULL)"},{"path":"/reference/DW_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize DW Module State — DW_init_state","title":"Initialize DW Module State — DW_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/DW_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize DW Module State — DW_init_state","text":"","code":"DW_init_state(FM_yaml_file, MOD_yaml_file, id, id_UD, session)"},{"path":"/reference/DW_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize DW Module State — DW_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id Shiny module ID id_UD ID string upload data module used handle uploads name list element react_state data set stored. session Shiny session variable module (NULL)","code":""},{"path":"/reference/DW_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize DW Module State — DW_init_state","text":"list containing empty DW state","code":""},{"path":"/reference/DW_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize DW Module State — DW_init_state","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input state = DW_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"DW.yaml\"), id = \"DW\", id_UD = \"UD\", session = session) #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] TRUE #> #> $MC$compact$preview #> [1] TRUE #> #> $MC$compact$clip #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] TRUE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$notifications #> $MC$notifications$new_dw_element #> [1] \"Added element: ===ACTION=== (===DESC===)\" #> #> $MC$notifications$del_dw_element #> [1] \"Removed element: ===ACTION=== (===DESC===)\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data wrangling code\" #> #> $MC$tooltips$dw_elements #> [1] \"Current wrangling elements\" #> #> #> $MC$labels #> $MC$labels$tab_main #> [1] \"Wrangle\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$add_element #> [1] \"Add Operation/Action\" #> #> $MC$labels$fds_filter_column #> [1] \"Filter by Column\" #> #> $MC$labels$fds_filter_operator #> [1] \"Condition\" #> #> $MC$labels$fds_filter_rhs #> [1] \"Matching\" #> #> $MC$labels$fds_mutate_column #> [1] \"New or current column to alter\" #> #> $MC$labels$fds_mutate_rhs #> [1] \"New Value\" #> #> $MC$labels$fds_rename_column #> [1] \"Curret Column\" #> #> $MC$labels$fds_rename_rhs #> [1] \"New Name\" #> #> $MC$labels$fds_group_column #> [1] \"Columns to group\" #> #> $MC$labels$fds_longer_column #> [1] \"Columns to make longer\" #> #> $MC$labels$fds_longer_names #> [1] \"New column to contain names\" #> #> $MC$labels$fds_longer_values #> [1] \"New column to contain values\" #> #> $MC$labels$fds_wider_names #> [1] \"Column with names\" #> #> $MC$labels$fds_wider_values #> [1] \"Column with values\" #> #> $MC$labels$new_dw #> [1] \"New\" #> #> $MC$labels$del_dw #> [1] \"Delete\" #> #> $MC$labels$save_dw #> [1] \"Save\" #> #> $MC$labels$copy_dw #> [1] \"Copy\" #> #> $MC$labels$clip_dw #> [1] \"Code\" #> #> $MC$labels$ungroup_data #> [1] \"Removing current grouping\" #> #> $MC$labels$keep_onerow #> [1] \"Keep first row in current grouping\" #> #> $MC$labels$no_dataset #> [1] \"No dataset available to wrangle. You need to load a dataset to use this module.\" #> #> $MC$labels$no_dw_elements #> [1] \"No data wrangling elements defined yet\" #> #> $MC$labels$busy #> $MC$labels$busy$dv_update #> [1] \"Updating data views. Please be patient...\" #> #> #> #> $MC$errors #> $MC$errors$fds_filter_column #> [1] \"Filter column not specified.\" #> #> $MC$errors$fds_filter_operator #> [1] \"Filter condition not specified.\" #> #> $MC$errors$fds_filter_rhs #> [1] \"Filter RHS not specified.\" #> #> $MC$errors$fds_mutate_column #> [1] \"Mutate column not specified.\" #> #> $MC$errors$fds_mutate_rhs #> [1] \"Mutate RHS not specified.\" #> #> $MC$errors$fds_rename_column #> [1] \"Column to rename not specified.\" #> #> $MC$errors$fds_rename_rhs #> [1] \"New column name not specified.\" #> #> $MC$errors$fds_group_column #> [1] \"No columns to group specified.\" #> #> $MC$errors$fds_select_column #> [1] \"You must select at least one column to keep.\" #> #> $MC$errors$fds_longer_column #> [1] \"You must select at least one column to make longer.\" #> #> $MC$errors$fds_longer_names #> [1] \"You must supply a column for the names of the new longer dataset\" #> #> $MC$errors$fds_longer_values #> [1] \"You must supply a column for the values of the new longer dataset\" #> #> $MC$errors$fds_wider_names #> [1] \"You must select a column with the names.\" #> #> $MC$errors$`fds_wider_value s` #> [1] \"You must select a column with the values.\" #> #> $MC$errors$current_key #> [1] \"Short description\" #> #> $MC$errors$current_key_empty #> [1] \"The data view description field cannot be empty\" #> #> $MC$errors$unknown_action #> [1] \"The selection action is not supported.\" #> #> $MC$errors$no_rows #> [1] \"There are no rows in the data set.\" #> #> $MC$errors$element_not_added #> [1] \"Unable to add the data wrangling element:\" #> #> $MC$errors$fix_bad_element #> [1] \"There is a bad element in the data wrangling chain,\\nyou need to fix that before adding new elements\" #> #> #> $MC$operators #> $MC$operators[[1]] #> $MC$operators[[1]]$type #> [1] \"factor\" #> #> $MC$operators[[1]]$text #> [1] \"is one of\" #> #> $MC$operators[[1]]$rop #> [1] \"%in%\" #> #> #> $MC$operators[[2]] #> $MC$operators[[2]]$type #> [1] \"factor\" #> #> $MC$operators[[2]]$text #> [1] \"is not\" #> #> $MC$operators[[2]]$rop #> [1] \"!%in%\" #> #> #> $MC$operators[[3]] #> $MC$operators[[3]]$type #> [1] \"not_factor\" #> #> $MC$operators[[3]]$text #> [1] \"is within the range\" #> #> $MC$operators[[3]]$rop #> [1] \"within\" #> #> #> $MC$operators[[4]] #> $MC$operators[[4]]$type #> [1] \"not_factor\" #> #> $MC$operators[[4]]$text #> [1] \"is equal to\" #> #> $MC$operators[[4]]$rop #> [1] \"==\" #> #> #> $MC$operators[[5]] #> $MC$operators[[5]]$type #> [1] \"not_factor\" #> #> $MC$operators[[5]]$text #> [1] \"is not equal to\" #> #> $MC$operators[[5]]$rop #> [1] \"!=\" #> #> #> #> $MC$actions #> $MC$actions$filter #> $MC$actions$filter$choice #> [1] \"Filter\" #> #> $MC$actions$filter$subtext #> [1] \"Filter data\" #> #> #> $MC$actions$mutate #> $MC$actions$mutate$choice #> [1] \"Alter\" #> #> $MC$actions$mutate$subtext #> [1] \"Create new column or change existing column\" #> #> #> $MC$actions$rename #> $MC$actions$rename$choice #> [1] \"Rename\" #> #> $MC$actions$rename$subtext #> [1] \"Rename column\" #> #> #> $MC$actions$group #> $MC$actions$group$choice #> [1] \"Group\" #> #> $MC$actions$group$subtext #> [1] \"Group subsequent operations by columns\" #> #> #> $MC$actions$ungroup #> $MC$actions$ungroup$choice #> [1] \"Ungroup\" #> #> $MC$actions$ungroup$subtext #> [1] \"Removing groping\" #> #> #> $MC$actions$longer #> $MC$actions$longer$choice #> [1] \"Elongate\" #> #> $MC$actions$longer$subtext #> [1] \"Make Longer: rows to columns\" #> #> #> $MC$actions$wider #> $MC$actions$wider$choice #> [1] \"Widen\" #> #> $MC$actions$wider$subtext #> [1] \"Make Wider: columns to rows\" #> #> #> $MC$actions$onerow #> $MC$actions$onerow$choice #> [1] \"First Row\" #> #> $MC$actions$onerow$subtext #> [1] \"Keep only first row of grouped data\" #> #> #> $MC$actions$select #> $MC$actions$select$choice #> [1] \"Select\" #> #> $MC$actions$select$subtext #> [1] \"Choose columns to keep\" #> #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 400 #> #> #> $MC$formatting$dw_elements #> $MC$formatting$dw_elements$width #> [1] 600 #> #> $MC$formatting$dw_elements$height #> [1] 200 #> #> #> $MC$formatting$current_key #> $MC$formatting$current_key$width #> [1] 300 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 800 #> #> $MC$formatting$code$height #> [1] 300 #> #> #> $MC$formatting$button_dw_del #> $MC$formatting$button_dw_del$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_del$block #> [1] TRUE #> #> $MC$formatting$button_dw_del$tooltip #> [1] \"Delete the current data view.\" #> #> $MC$formatting$button_dw_del$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_clip #> $MC$formatting$button_dw_clip$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_clip$block #> [1] TRUE #> #> $MC$formatting$button_dw_clip$tooltip #> [1] \"Copy code to generate current data view to the clipboard.\" #> #> $MC$formatting$button_dw_clip$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_save #> $MC$formatting$button_dw_save$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_save$block #> [1] TRUE #> #> $MC$formatting$button_dw_save$tooltip #> [1] \"Save changes to data view name\" #> #> $MC$formatting$button_dw_save$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_copy #> $MC$formatting$button_dw_copy$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_copy$block #> [1] TRUE #> #> $MC$formatting$button_dw_copy$tooltip #> [1] \"Copy current data view to a new data view.\" #> #> $MC$formatting$button_dw_copy$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_new #> $MC$formatting$button_dw_new$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_new$block #> [1] TRUE #> #> $MC$formatting$button_dw_new$tooltip #> [1] \"Create a new empty data view.\" #> #> $MC$formatting$button_dw_new$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_dw_add_element #> $MC$formatting$button_dw_add_element$size #> [1] \"sm\" #> #> $MC$formatting$button_dw_add_element$block #> [1] TRUE #> #> #> #> $MC$code #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$packages #> [1] \"dplyr\" \"tidyr\" #> #> $MC$code$preamble #> [1] \"# Data wrangling ----------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"DW_myDS\" #> #> #> $DW #> $DW$button_counters #> $DW$button_counters$button_dw_add_element #> [1] 0 #> #> $DW$button_counters$button_dw_new #> [1] 0 #> #> $DW$button_counters$button_dw_del #> [1] 0 #> #> $DW$button_counters$button_dw_save #> [1] 0 #> #> $DW$button_counters$button_dw_copy #> [1] 0 #> #> #> $DW$ui_hold #> $DW$ui_hold$hot_dw_elements #> [1] FALSE #> #> $DW$ui_hold$current_key #> [1] FALSE #> #> $DW$ui_hold$select_dw_views #> [1] FALSE #> #> #> $DW$ui_ids #> [1] \"hot_dw_elements\" \"button_dw_add_element\" #> [3] \"button_dw_new\" \"button_dw_del\" #> [5] \"button_dw_copy\" \"button_dw_save\" #> [7] \"select_fds_filter_column\" \"select_fds_filter_operator\" #> [9] \"fds_filter_rhs\" \"select_fds_mutate_column\" #> [11] \"select_fds_mutate_rhs\" \"select_fds_rename_column\" #> [13] \"fds_rename_rhs\" \"current_key\" #> [15] \"select_fds_group_column\" \"select_fds_select_column\" #> [17] \"select_fds_longer_column\" \"select_fds_longer_values\" #> [19] \"select_fds_longer_names\" \"select_fds_wider_values\" #> [21] \"select_fds_wider_names\" \"select_dw_views\" #> [23] \"select_dw_element\" #> #> $DW$isgood #> [1] TRUE #> #> $DW$op_choices #> $DW$op_choices$factor #> is one of is not #> \"%in%\" \"!%in%\" #> #> $DW$op_choices$not_factor #> is within the range is equal to is not equal to #> \"within\" \"==\" \"!=\" #> #> #> $DW$view_cntr #> [1] 1 #> #> $DW$UD #> $DW$UD$isgood #> [1] TRUE #> #> $DW$UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $DW$UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> $DW$UD$object_name #> [1] \"myDS\" #> #> #> $DW$code_previous #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $DW$views #> $DW$views$view_1 #> $DW$views$view_1$isgood #> [1] TRUE #> #> $DW$views$view_1$id #> [1] \"view_1\" #> #> $DW$views$view_1$idx #> [1] 1 #> #> $DW$views$view_1$view_ds_object_name #> [1] \"DW_myDS_1\" #> #> $DW$views$view_1$code_previous #> [1] \"DW_myDS_1 = myDS\" #> #> $DW$views$view_1$key #> [1] \"data_view_1\" #> #> $DW$views$view_1$WDS #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> $DW$views$view_1$elements_table #> NULL #> #> $DW$views$view_1$checksum #> [1] \"b18a369b1e4d93010a04a56c7cde00c8\" #> #> $DW$views$view_1$code #> NULL #> #> $DW$views$view_1$code_dw_only #> NULL #> #> #> #> $DW$current_view #> [1] \"view_1\" #> #> $DW$checksum #> [1] \"5b0f0b05ee3ac7336a74c564bb6efdad\" #> #> #> $MOD_TYPE #> [1] \"DW\" #> #> $id #> [1] \"DW\" #> #> $dep_mod_ids #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/DW.yaml\" #>"},{"path":"/reference/DW_new_view.html","id":null,"dir":"Reference","previous_headings":"","what":"New Data Wrangling View — DW_new_view","title":"New Data Wrangling View — DW_new_view","text":"Appends new empty data wrangling view DW state object makes new view active view.","code":""},{"path":"/reference/DW_new_view.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"New Data Wrangling View — DW_new_view","text":"","code":"DW_new_view(state)"},{"path":"/reference/DW_new_view.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"New Data Wrangling View — DW_new_view","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_new_view.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"New Data Wrangling View — DW_new_view","text":"DW state object containing new data view view set current active view. See help DW_fetch_state() view format.","code":""},{"path":"/reference/DW_new_view.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"New Data Wrangling View — DW_new_view","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_set_current_view.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Current Data View — DW_set_current_view","title":"Sets Current Data View — DW_set_current_view","text":"Takes DW state updated view sets view current view_id","code":""},{"path":"/reference/DW_set_current_view.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Current Data View — DW_set_current_view","text":"","code":"DW_set_current_view(state, dw_view)"},{"path":"/reference/DW_set_current_view.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Current Data View — DW_set_current_view","text":"state DW state DW_fetch_state() dw_view Data view list format returned DW_fetch_current_view() (see structure state$DW$views output DW_fetch_state()).","code":""},{"path":"/reference/DW_set_current_view.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Current Data View — DW_set_current_view","text":"DW state object value dw_view set current view id.","code":""},{"path":"/reference/DW_set_current_view.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Current Data View — DW_set_current_view","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/DW_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — DW_test_mksession","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/DW_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"","code":"DW_test_mksession(session, id = \"DW\", id_UD = \"UD\")"},{"path":"/reference/DW_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements id_UD ID string corresponds ID used call UD modules UI elements","code":""},{"path":"/reference/DW_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/DW_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — DW_test_mksession","text":"","code":"sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b"},{"path":"/reference/DW_update_checksum.html","id":null,"dir":"Reference","previous_headings":"","what":"Updates DW Module Checksum — DW_update_checksum","title":"Updates DW Module Checksum — DW_update_checksum","text":"Takes DW state updates checksum used trigger downstream updates","code":""},{"path":"/reference/DW_update_checksum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Updates DW Module Checksum — DW_update_checksum","text":"","code":"DW_update_checksum(state)"},{"path":"/reference/DW_update_checksum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Updates DW Module Checksum — DW_update_checksum","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/DW_update_checksum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Updates DW Module Checksum — DW_update_checksum","text":"DW state object checksum updated","code":""},{"path":"/reference/DW_update_checksum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Updates DW Module Checksum — DW_update_checksum","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # We also need a state variable state = sess_res$state state = DW_update_checksum(state) #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b"},{"path":"/reference/FG_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Figure Generation Server — FG_Server","title":"Figure Generation Server — FG_Server","text":"Server function figure generation module","code":""},{"path":"/reference/FG_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Figure Generation Server — FG_Server","text":"","code":"FG_Server( id, FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"FG.yaml\"), id_ASM = \"ASM\", id_UD = \"UD\", id_DW = \"DW\", deployed = FALSE, react_state = NULL )"},{"path":"/reference/FG_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Figure Generation Server — FG_Server","text":"id ID string corresponds ID used call module's UI function FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id_ASM ID string app state management module used save load app states id_UD ID string upload data module used handle uploads name list element react_state data set stored. id_DW ID string data wrangling module process uploaded data deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/FG_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Figure Generation Server — FG_Server","text":"FG Server object","code":""},{"path":"/reference/FG_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Figure Generation Server — FG_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/FG_append_report.html","id":null,"dir":"Reference","previous_headings":"","what":"Append Report Elements — FG_append_report","title":"Append Report Elements — FG_append_report","text":"Description","code":""},{"path":"/reference/FG_append_report.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Append Report Elements — FG_append_report","text":"","code":"FG_append_report(state, rpt, rpttype, gen_code_only = FALSE)"},{"path":"/reference/FG_append_report.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Append Report Elements — FG_append_report","text":"state FG state FG_fetch_state() rpt Report current content report appended function. details structure see documentation FM_generate_report. rpttype Type report generate (supported \"xlsx\", \"pptx\", \"docx\"). gen_code_only Boolean value indicating code generated (FALSE).","code":""},{"path":"/reference/FG_append_report.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Append Report Elements — FG_append_report","text":"list containing following elements isgood: Return status function. hasrptele: Boolean indicator module reportable elements. code: Data wrangling R command. msgs: Messages passed back user. rpt: Report additions passed back user.","code":""},{"path":[]},{"path":"/reference/FG_append_report.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Append Report Elements — FG_append_report","text":"","code":"sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 state = sess_res$state # This will read in the default PowerPoint report template rpt = onbrand::read_template( template = system.file(package=\"onbrand\",\"templates\",\"report.pptx\"), mapping = system.file(package=\"onbrand\",\"templates\",\"report.yaml\")) rpt_res = FG_append_report(state = state, rpt = rpt, rpttype = \"pptx\", gen_code_only=TRUE) # Shows if report elements are present rpt_res$hasrptele #> [1] TRUE # Code chunk to generate report element cat(paste(rpt_res$code, collapse=\"\\n\")) #> # Figure Fig_1(1): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=1)), #> type = \"ggplot\"))) #> # Figure Fig_1(2): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=2)), #> type = \"ggplot\")))"},{"path":"/reference/FG_build.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluates Figure Generation Code — FG_build","title":"Evaluates Figure Generation Code — FG_build","text":"Takes current state rebuilds active figure. elements table row flagged deletion, deleted. cmd input NULL attempt append element figure.","code":""},{"path":"/reference/FG_build.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluates Figure Generation Code — FG_build","text":"","code":"FG_build( state, del_row = NULL, cmd = NULL, element = \"unknown\", desc = \"unknown\" )"},{"path":"/reference/FG_build.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluates Figure Generation Code — FG_build","text":"state FG state FG_fetch_state() del_row Row number deleted (NULL rows need deleted) cmd String containing plotting command. Set NULL initialize new figure force rebuild dataset update. element Short name figure element performed, eg. point desc Verbose description action performed","code":""},{"path":"/reference/FG_build.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Evaluates Figure Generation Code — FG_build","text":"list following elements isgood: Return status function. msgs: Messages passed back user. pages: List element containing ggplot object (p) code generate object (code)","code":""},{"path":"/reference/FG_build.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Evaluates Figure Generation Code — FG_build","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:96db745c38408478cb1788f44905a48a"},{"path":"/reference/FG_extract_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Extracts Specific Page from Paginated Figure — FG_extract_page","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"Used extract specified page current figure.","code":""},{"path":"/reference/FG_extract_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"","code":"FG_extract_page(state, page)"},{"path":"/reference/FG_extract_page.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"state FG state FG_fetch_state() page Page number extract","code":""},{"path":"/reference/FG_extract_page.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"ggplot object specified page.","code":""},{"path":"/reference/FG_extract_page.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Extracts Specific Page from Paginated Figure — FG_extract_page","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:96db745c38408478cb1788f44905a48a"},{"path":"/reference/FG_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — FG_fetch_code","title":"Fetch Module Code — FG_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/FG_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — FG_fetch_code","text":"","code":"FG_fetch_code(state)"},{"path":"/reference/FG_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — FG_fetch_code","text":"state UD state FG_fetch_state()","code":""},{"path":"/reference/FG_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — FG_fetch_code","text":"Character object vector lines code","code":""},{"path":"/reference/FG_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — FG_fetch_code","text":"","code":"# This will create a populated FG state object: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 state = sess_res$state code = FG_fetch_code(state) cat(paste(code, collapse=\"\\n\")) #> # Individual profiles by cohort =========================================== #> FG_myp_1 = ggplot2::ggplot(data=DW_myDS_1) #> FG_myp_1 = FG_myp_1 + geom_line(aes(x=TIME_DY, y=DV, color=CMT, group=IDCMT)) #> FG_myp_1 = FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=1) #> FG_myp_1 = FG_myp_1 + scale_y_log10(limits=NULL) #> FG_myp_1 = FG_myp_1 + ggplot2::theme_light()"},{"path":"/reference/FG_fetch_current_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Current Figure — FG_fetch_current_fig","title":"Fetches Current Figure — FG_fetch_current_fig","text":"Takes FG state returns current active figure","code":""},{"path":"/reference/FG_fetch_current_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Current Figure — FG_fetch_current_fig","text":"","code":"FG_fetch_current_fig(state)"},{"path":"/reference/FG_fetch_current_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Current Figure — FG_fetch_current_fig","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/FG_fetch_current_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Current Figure — FG_fetch_current_fig","text":"List containing details active figure. structure list structure state$FG$figs output FG_fetch_state().","code":""},{"path":"/reference/FG_fetch_current_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Current Figure — FG_fetch_current_fig","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:96db745c38408478cb1788f44905a48a"},{"path":"/reference/FG_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Figure Generation State — FG_fetch_state","title":"Fetch Figure Generation State — FG_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/FG_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Figure Generation State — FG_fetch_state","text":"","code":"FG_fetch_state( id, input, session, FM_yaml_file, MOD_yaml_file, id_ASM = NULL, id_UD = NULL, id_DW = NULL, react_state )"},{"path":"/reference/FG_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Figure Generation State — FG_fetch_state","text":"id Shiny module ID input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id_ASM ID string app state management module used save load app states id_UD ID string upload data module used handle uploads name list element react_state data set stored. id_DW ID string data wrangling module process uploaded data react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/FG_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Figure Generation State — FG_fetch_state","text":"list containing current state app including default values yaml file well changes made user. structure list defined : yaml: Contents yaml file. MC: Module components yaml file. FG: Data wrangling state isgood: Boolean status state. Currently just TRUE button_counters: List counters detect button clicks. ui_msg: Message returned users perform actions. ui: Current value form elements UI. ui_ids: Vector UI elements module. ui_hold: List hold elements disable updates full ui referesh complete. checksum: checksum FG module used detect changes module. aes_elements: Plot elements defined aesthetics (.e. X geom_X) current_fig: fig_id currently figure. fig_cntr: Counter figures, incremented time new figure created. DSV: Available data sets UD DW modules. figs: List figures. view following structure: add_isgood: JMH checksum: Checksum figure used detect changes figure. code: Code generate figure start finish. code_fg_only: Code just generate figure. code_previous: Code load /wrangle dataset. elements_table: Table figure generation elements. fg_object_name: JMH fig_dsview: Name dataset view current figure (also R object name dataset view). fobj: JMH id: Character id (fig_idx) idx: Numeric id (1) isgood: Boolean status figure. FALSE evaluation/build fails. key: Figure key acts title/caption (user editable) msgs: JMH notes: Figure notes (user editable) num_pages: JMH page: JMH MOD_TYPE: Character data containing type module \"DW\" id: Character data containing module id module session variable. FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section.","code":""},{"path":"/reference/FG_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Figure Generation State — FG_fetch_state","text":"","code":"# Configuration files FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"FG.yaml\") # We need to specify both the FG module id as well as the # id of the UD module that feeds into it. id = \"FG\" id_UD = \"UD\" id_DW = \"DW\" # These would be the Shiny input and session variables input = list() session = list() # Creating an empty state object state = FG_fetch_state(id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file, id_UD = id_UD, id_DW = id_DW, react_state = NULL) #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: figure page change detected state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] TRUE #> #> $MC$compact$preview #> [1] \"ggplot\" #> #> $MC$compact$clip #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] TRUE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$manual #> $MC$tooltips$components$manual$x #> [1] \"Numeric location on the x-axis\" #> #> $MC$tooltips$components$manual$y #> [1] \"Numeric location on the y-axis\" #> #> $MC$tooltips$components$manual$color #> [1] \"A named color red, blue, green\" #> #> $MC$tooltips$components$manual$linetype #> [1] \"Specify either solid, dashed, dotted, dotdash, longdash or twodash\" #> #> $MC$tooltips$components$manual$shape #> [1] \"Open shapes: square (0), circle (1), triangle (2); Filled shapes: square (15), circle (16), triangle (17)\" #> #> $MC$tooltips$components$manual$size #> [1] \"Numeric value\" #> #> $MC$tooltips$components$manual$alpha #> [1] \"Numeric value between 0 (completely transparent) and 1 (solid)\" #> #> $MC$tooltips$components$manual$group #> NULL #> #> $MC$tooltips$components$manual$xintercept #> NULL #> #> $MC$tooltips$components$manual$yintercept #> NULL #> #> #> #> $MC$tooltips$ph #> $MC$tooltips$ph$notes #> [1] \"Optional figure notes that will be carried over and used in other elements (e.g. reporting).\" #> #> $MC$tooltips$ph$fig_key #> [1] \"Unique description used for referencing figures and in other elements (e.g. reporting).\" #> #> #> $MC$tooltips$show_code #> [1] \"Show figure generation code\" #> #> $MC$tooltips$fg_elements #> [1] \"Current figure elements\" #> #> #> $MC$labels #> $MC$labels$components #> $MC$labels$components$x #> [1] \"x-axis\" #> #> $MC$labels$components$y #> [1] \"y-axis\" #> #> $MC$labels$components$color #> [1] \"color\" #> #> $MC$labels$components$linetype #> [1] \"line type\" #> #> $MC$labels$components$fill #> [1] \"fill color\" #> #> $MC$labels$components$weight #> [1] \"weight\" #> #> $MC$labels$components$ymin #> [1] \"ymin\" #> #> $MC$labels$components$ymax #> [1] \"ymax\" #> #> $MC$labels$components$lower #> [1] \"lower\" #> #> $MC$labels$components$middle #> [1] \"middle\" #> #> $MC$labels$components$upper #> [1] \"upper\" #> #> $MC$labels$components$shape #> [1] \"shape\" #> #> $MC$labels$components$size #> [1] \"size\" #> #> $MC$labels$components$alpha #> [1] \"transparency\" #> #> $MC$labels$components$group #> [1] \"group\" #> #> $MC$labels$components$xintercept #> [1] \"x intercept\" #> #> $MC$labels$components$yintercept #> [1] \"y intercept\" #> #> $MC$labels$components$yscale #> [1] \"y-scale\" #> #> $MC$labels$components$xscale #> [1] \"x-scale\" #> #> $MC$labels$components$ylim #> [1] \"y limits\" #> #> $MC$labels$components$xlim #> [1] \"x limits\" #> #> #> $MC$labels$ph #> $MC$labels$ph$xlab #> [1] \"x-axis label\" #> #> $MC$labels$ph$ylab #> [1] \"y-axis label\" #> #> $MC$labels$ph$ggtitle #> [1] \"plot title\" #> #> $MC$labels$ph$notes #> [1] \"optional notes here\" #> #> $MC$labels$ph$fig_key #> [1] \"title/caption\" #> #> $MC$labels$ph$manual #> [1] \"Manual\" #> #> $MC$labels$ph$axlim #> [1] \"0.1, 1000 # Empty for auto\" #> #> #> $MC$labels$manual #> [1] \"Manual\" #> #> $MC$labels$not_used #> [1] \"Not Used\" #> #> $MC$labels$curr_figs_none #> [1] \"No figures yet created\" #> #> $MC$labels$no_fig_elements #> [1] \"Add figure elements\" #> #> $MC$labels$new_fig #> [1] \"New\" #> #> $MC$labels$save_fig #> [1] \"Save\" #> #> $MC$labels$del_fig #> [1] \"Delete\" #> #> $MC$labels$copy_fig #> [1] \"Copy\" #> #> $MC$labels$clip_fig #> [1] \"Code\" #> #> $MC$labels$upds_fig #> [1] \"Data set\" #> #> $MC$labels$add_ele #> [1] \"Add Figure Element\" #> #> $MC$labels$msg_bad_label #> [1] \"No labels were specified, unable to add element.\" #> #> $MC$labels$msg_bad_facet #> [1] \"At least one column must be selected to add a faceting element.\" #> #> $MC$labels$msg_bad_element #> [1] \"Unable to add the specified element: ===ELEMENT===\" #> #> $MC$labels$msg_bad_manual_comp #> [1] \"The plot element component ===COMP=== was specified manually but \\nno manual value was provided.\" #> #> $MC$labels$select_current_fig #> [1] \"Current figure\" #> #> $MC$labels$select_current_view #> [1] \"Data from\" #> #> $MC$labels$no_figures_defined #> [1] \"No figures have been defined. There are no data sources to create figures. You need to load data and create data views to use this module.\" #> #> $MC$labels$busy #> $MC$labels$busy$fig_update #> [1] \"Updating the current figure. Please be patient...\" #> #> #> #> $MC$errors #> $MC$errors$element_not_added #> [1] \"Unable to add the data figure element:\" #> #> $MC$errors$current_key_empty #> [1] \"The figure description field cannot be empty.\" #> #> $MC$errors$only_one_element #> [1] \"Only one element of ===ELEMENT=== type is allowed. The old ===ELEMENT=== will be replaced.\" #> #> #> $MC$elements #> $MC$elements$line #> $MC$elements$line$choice #> [1] \"Line\" #> #> $MC$elements$line$subtext #> [1] \"Continuous line\" #> #> $MC$elements$line$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"linetype\" \"size\" \"alpha\" #> #> $MC$elements$line$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$line$fcn #> [1] \"geom_line\" #> #> #> $MC$elements$point #> $MC$elements$point$choice #> [1] \"Point\" #> #> $MC$elements$point$subtext #> [1] \"Scatter plot\" #> #> $MC$elements$point$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"shape\" \"size\" \"alpha\" #> #> $MC$elements$point$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$point$fcn #> [1] \"geom_point\" #> #> #> $MC$elements$errorbar #> $MC$elements$errorbar$choice #> [1] \"Errobar\" #> #> $MC$elements$errorbar$subtext #> [1] \"Errorbars around points\" #> #> $MC$elements$errorbar$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"size\" \"alpha\" #> #> $MC$elements$errorbar$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$errorbar$fcn #> [1] \"geom_errorbar\" #> #> #> $MC$elements$hguide #> $MC$elements$hguide$choice #> [1] \"H-Guide\" #> #> $MC$elements$hguide$subtext #> [1] \"Horizontal guide\" #> #> $MC$elements$hguide$ui_aes #> [1] \"yintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$hguide$aes_req #> [1] \"yintercept\" #> #> $MC$elements$hguide$fcn #> [1] \"geom_hline\" #> #> #> $MC$elements$vguide #> $MC$elements$vguide$choice #> [1] \"V-Guide\" #> #> $MC$elements$vguide$subtext #> [1] \"Vertical guide\" #> #> $MC$elements$vguide$ui_aes #> [1] \"xintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$vguide$aes_req #> [1] \"xintercept\" #> #> $MC$elements$vguide$fcn #> [1] \"geom_vline\" #> #> #> $MC$elements$facet #> $MC$elements$facet$choice #> [1] \"Facet\" #> #> $MC$elements$facet$subtext #> [1] \"Facet by one or more variables\" #> #> #> $MC$elements$label #> $MC$elements$label$choice #> [1] \"Label\" #> #> $MC$elements$label$subtext #> [1] \"Label axes or plot title\" #> #> $MC$elements$label$ui_text #> [1] \"xlab\" \"ylab\" \"ggtitle\" #> #> #> $MC$elements$scales #> $MC$elements$scales$choice #> [1] \"Format Axes\" #> #> $MC$elements$scales$subtext #> [1] \"Axis scales and limits\" #> #> #> $MC$elements$smooth #> $MC$elements$smooth$choice #> [1] \"Smooth Trend\" #> #> $MC$elements$smooth$subtext #> [1] \"Smoothed conditional means\" #> #> $MC$elements$smooth$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"fill\" \"weight\" #> [7] \"linetype\" \"size\" \"alpha\" \"ymax\" \"ymin\" #> #> $MC$elements$smooth$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$smooth$fcn #> [1] \"geom_smooth\" #> #> #> $MC$elements$ribbon #> $MC$elements$ribbon$choice #> [1] \"Shaded Area\" #> #> $MC$elements$ribbon$subtext #> [1] \"Creating prediction intervals\" #> #> $MC$elements$ribbon$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"fill\" \"linetype\" #> [8] \"size\" \"alpha\" #> #> $MC$elements$ribbon$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$ribbon$fcn #> [1] \"geom_ribbon\" #> #> #> $MC$elements$boxplot #> $MC$elements$boxplot$choice #> [1] \"Boxplot\" #> #> $MC$elements$boxplot$subtext #> [1] \"Box and whiskers plot\" #> #> $MC$elements$boxplot$ui_aes #> [1] \"x\" \"y\" \"lower\" \"middle\" \"upper\" \"ymin\" #> [7] \"ymax\" \"color\" \"group\" \"fill\" \"weight\" \"linetype\" #> [13] \"size\" \"shape\" \"alpha\" #> #> $MC$elements$boxplot$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$boxplot$fcn #> [1] \"geom_boxplot\" #> #> #> #> $MC$formatting #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 800 #> #> $MC$formatting$code$height #> [1] 300 #> #> #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 400 #> #> #> $MC$formatting$select_fg_page #> $MC$formatting$select_fg_page$width #> [1] 1000 #> #> #> $MC$formatting$notes #> $MC$formatting$notes$width #> [1] \"560px\" #> #> $MC$formatting$notes$height #> [1] \"75px\" #> #> #> $MC$formatting$components #> $MC$formatting$components$aes #> $MC$formatting$components$aes$width #> [1] \"100px\" #> #> #> $MC$formatting$components$facet #> $MC$formatting$components$facet$width #> [1] \"200px\" #> #> #> $MC$formatting$components$label #> $MC$formatting$components$label$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axscale #> $MC$formatting$components$axscale$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axlim #> $MC$formatting$components$axlim$width #> [1] \"150px\" #> #> #> #> $MC$formatting$select_current_fig #> $MC$formatting$select_current_fig$width #> [1] 200 #> #> #> $MC$formatting$select_current_view #> $MC$formatting$select_current_view$width #> [1] 200 #> #> #> $MC$formatting$fg_elements #> $MC$formatting$fg_elements$width #> [1] 600 #> #> $MC$formatting$fg_elements$height #> [1] 200 #> #> #> $MC$formatting$faceting #> $MC$formatting$faceting$nrow #> [1] 3 #> #> $MC$formatting$faceting$ncol #> [1] 4 #> #> #> $MC$formatting$button_fig_del #> $MC$formatting$button_fig_del$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_del$block #> [1] TRUE #> #> $MC$formatting$button_fig_del$tooltip #> [1] \"Delete the current figure.\" #> #> $MC$formatting$button_fig_del$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_save #> $MC$formatting$button_fig_save$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_save$block #> [1] TRUE #> #> $MC$formatting$button_fig_save$tooltip #> [1] \"Save changes to caption, notes and data source.\" #> #> $MC$formatting$button_fig_save$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_clip #> $MC$formatting$button_fig_clip$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_clip$block #> [1] TRUE #> #> $MC$formatting$button_fig_clip$tooltip #> [1] \"Copy code to generate current figure to the clipboard.\" #> #> $MC$formatting$button_fig_clip$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_copy #> $MC$formatting$button_fig_copy$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_copy$block #> [1] TRUE #> #> $MC$formatting$button_fig_copy$tooltip #> [1] \"Copy current figure to a new figure.\" #> #> $MC$formatting$button_fig_copy$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_new #> $MC$formatting$button_fig_new$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_new$block #> [1] TRUE #> #> $MC$formatting$button_fig_new$tooltip #> [1] \"Create a new empty figure.\" #> #> $MC$formatting$button_fig_new$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_add #> $MC$formatting$button_fig_add$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_add$block #> [1] TRUE #> #> #> #> $MC$post_processing #> [1] \"===FGOBJ=== = ===FGOBJ=== + ggplot2::theme_light()\" #> #> $MC$fg_object_name #> [1] \"myp\" #> #> $MC$code #> $MC$code$packages #> [1] \"ggplot2\" \"ggforce\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Generating figures ------------------------------------------------------\" #> #> #> #> $FG #> $FG$button_counters #> $FG$button_counters$button_element_add #> [1] 0 #> #> $FG$button_counters$button_fig_save #> [1] 0 #> #> $FG$button_counters$button_fig_new #> [1] 0 #> #> $FG$button_counters$button_fig_del #> [1] 0 #> #> $FG$button_counters$button_fig_copy #> [1] 0 #> #> #> $FG$ui_hold #> $FG$ui_hold$hot_fg_elements #> [1] FALSE #> #> $FG$ui_hold$text_fig_key #> [1] FALSE #> #> $FG$ui_hold$text_fig_notes #> [1] FALSE #> #> $FG$ui_hold$select_current_view #> [1] FALSE #> #> $FG$ui_hold$select_current_fig #> [1] FALSE #> #> #> $FG$ui_ids #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" \"text_component_x_manual\" #> [9] \"text_component_y_manual\" \"text_component_color_manual\" #> [11] \"text_component_group_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_alpha_manual\" #> [15] \"select_component_shape\" \"text_component_shape_manual\" #> [17] \"select_component_ymin\" \"select_component_ymax\" #> [19] \"text_component_ymin_manual\" \"text_component_ymax_manual\" #> [21] \"select_component_yintercept\" \"text_component_yintercept_manual\" #> [23] \"select_component_xintercept\" \"text_component_xintercept_manual\" #> [25] \"select_component_fill\" \"select_component_weight\" #> [27] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [29] \"select_component_lower\" \"select_component_middle\" #> [31] \"select_component_upper\" \"text_component_lower_manual\" #> [33] \"text_component_middle_manual\" \"text_component_upper_manual\" #> [35] \"button_fig_new\" \"button_fig_save\" #> [37] \"button_fig_del\" \"button_fig_copy\" #> [39] \"button_element_add\" \"hot_fg_elements\" #> [41] \"text_fig_key\" \"text_fig_notes\" #> [43] \"text_component_xlab\" \"text_component_ylab\" #> [45] \"text_component_xlim\" \"text_component_ylim\" #> [47] \"text_component_ggtitle\" \"select_fg_page\" #> [49] \"select_current_fig\" \"select_current_view\" #> [51] \"select_component_facet\" \"select_component_xscale\" #> [53] \"select_component_yscale\" \"select_fg_element\" #> #> $FG$isgood #> [1] FALSE #> #> $FG$DSV #> $FG$DSV$isgood #> [1] FALSE #> #> $FG$DSV$hasds #> [1] FALSE #> #> $FG$DSV$catalog #> NULL #> #> $FG$DSV$modules #> list() #> #> $FG$DSV$ds #> list() #> #> #> $FG$fig_cntr #> [1] 0 #> #> $FG$aes_elements #> [1] \"line\" \"point\" \"errorbar\" \"hguide\" \"vguide\" \"smooth\" \"ribbon\" #> [8] \"boxplot\" #> #> $FG$auto_elements #> $FG$auto_elements$line #> $FG$auto_elements$line$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$line$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$point #> $FG$auto_elements$point$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" \"select_component_color\" #> [4] \"select_component_group\" \"select_component_shape\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$point$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_shape_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$errorbar #> $FG$auto_elements$errorbar$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" \"select_component_ymax\" #> [4] \"select_component_color\" \"select_component_group\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$errorbar$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$hguide #> $FG$auto_elements$hguide$ui_aes_select_id #> [1] \"select_component_yintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$hguide$ui_aes_manual_id #> [1] \"text_component_yintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$vguide #> $FG$auto_elements$vguide$ui_aes_select_id #> [1] \"select_component_xintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$vguide$ui_aes_manual_id #> [1] \"text_component_xintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$smooth #> $FG$auto_elements$smooth$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_fill\" \"select_component_weight\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" \"select_component_ymax\" #> [11] \"select_component_ymin\" #> #> $FG$auto_elements$smooth$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" \"text_component_ymax_manual\" #> [11] \"text_component_ymin_manual\" #> #> #> $FG$auto_elements$ribbon #> $FG$auto_elements$ribbon$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" #> [3] \"select_component_ymax\" \"select_component_color\" #> [5] \"select_component_group\" \"select_component_fill\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" #> #> $FG$auto_elements$ribbon$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_fill_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$boxplot #> $FG$auto_elements$boxplot$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_lower\" \"select_component_middle\" #> [5] \"select_component_upper\" \"select_component_ymin\" #> [7] \"select_component_ymax\" \"select_component_color\" #> [9] \"select_component_group\" \"select_component_fill\" #> [11] \"select_component_weight\" \"select_component_linetype\" #> [13] \"select_component_size\" \"select_component_shape\" #> [15] \"select_component_alpha\" #> #> $FG$auto_elements$boxplot$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_lower_manual\" \"text_component_middle_manual\" #> [5] \"text_component_upper_manual\" \"text_component_ymin_manual\" #> [7] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [9] \"text_component_group_manual\" \"text_component_fill_manual\" #> [11] \"text_component_weight_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_shape_manual\" #> [15] \"text_component_alpha_manual\" #> #> #> #> $FG$ui #> $FG$ui$select_component_x #> [1] \"\" #> #> $FG$ui$select_component_y #> [1] \"\" #> #> $FG$ui$select_component_color #> [1] \"\" #> #> $FG$ui$select_component_group #> [1] \"\" #> #> $FG$ui$select_component_linetype #> [1] \"\" #> #> $FG$ui$select_component_size #> [1] \"\" #> #> $FG$ui$select_component_alpha #> [1] \"\" #> #> $FG$ui$text_component_x_manual #> [1] \"\" #> #> $FG$ui$text_component_y_manual #> [1] \"\" #> #> $FG$ui$text_component_color_manual #> [1] \"\" #> #> $FG$ui$text_component_group_manual #> [1] \"\" #> #> $FG$ui$text_component_linetype_manual #> [1] \"\" #> #> $FG$ui$text_component_size_manual #> [1] \"\" #> #> $FG$ui$text_component_alpha_manual #> [1] \"\" #> #> $FG$ui$select_component_shape #> [1] \"\" #> #> $FG$ui$text_component_shape_manual #> [1] \"\" #> #> $FG$ui$select_component_ymin #> [1] \"\" #> #> $FG$ui$select_component_ymax #> [1] \"\" #> #> $FG$ui$text_component_ymin_manual #> [1] \"\" #> #> $FG$ui$text_component_ymax_manual #> [1] \"\" #> #> $FG$ui$select_component_yintercept #> [1] \"\" #> #> $FG$ui$text_component_yintercept_manual #> [1] \"\" #> #> $FG$ui$select_component_xintercept #> [1] \"\" #> #> $FG$ui$text_component_xintercept_manual #> [1] \"\" #> #> $FG$ui$select_component_fill #> [1] \"\" #> #> $FG$ui$select_component_weight #> [1] \"\" #> #> $FG$ui$text_component_fill_manual #> [1] \"\" #> #> $FG$ui$text_component_weight_manual #> [1] \"\" #> #> $FG$ui$select_component_lower #> [1] \"\" #> #> $FG$ui$select_component_middle #> [1] \"\" #> #> $FG$ui$select_component_upper #> [1] \"\" #> #> $FG$ui$text_component_lower_manual #> [1] \"\" #> #> $FG$ui$text_component_middle_manual #> [1] \"\" #> #> $FG$ui$text_component_upper_manual #> [1] \"\" #> #> $FG$ui$button_fig_new #> [1] \"\" #> #> $FG$ui$button_fig_save #> [1] \"\" #> #> $FG$ui$button_fig_del #> [1] \"\" #> #> $FG$ui$button_fig_copy #> [1] \"\" #> #> $FG$ui$button_element_add #> [1] \"\" #> #> $FG$ui$hot_fg_elements #> [1] \"\" #> #> $FG$ui$text_fig_key #> [1] \"\" #> #> $FG$ui$text_fig_notes #> [1] \"\" #> #> $FG$ui$text_component_xlab #> [1] \"\" #> #> $FG$ui$text_component_ylab #> [1] \"\" #> #> $FG$ui$text_component_xlim #> [1] \"\" #> #> $FG$ui$text_component_ylim #> [1] \"\" #> #> $FG$ui$text_component_ggtitle #> [1] \"\" #> #> $FG$ui$select_fg_page #> [1] \"\" #> #> $FG$ui$select_current_fig #> [1] \"\" #> #> $FG$ui$select_current_view #> [1] \"\" #> #> $FG$ui$select_component_facet #> [1] \"\" #> #> $FG$ui$select_component_xscale #> [1] \"\" #> #> $FG$ui$select_component_yscale #> [1] \"\" #> #> $FG$ui$select_fg_element #> [1] \"\" #> #> #> $FG$current_fig #> [1] \"\" #> #> $FG$figs #> $FG$figs[[1]] #> $FG$figs[[1]]$page #> [1] \"\" #> #> #> #> #> $MOD_TYPE #> [1] \"FG\" #> #> $id #> [1] \"FG\" #> #> $dep_mod_ids #> [1] \"UD\" \"DW\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/FG.yaml\" #>"},{"path":"/reference/FG_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize FG Module State — FG_init_state","title":"Initialize FG Module State — FG_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/FG_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize FG Module State — FG_init_state","text":"","code":"FG_init_state(FM_yaml_file, MOD_yaml_file, id, id_UD, id_DW, session)"},{"path":"/reference/FG_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize FG Module State — FG_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id Shiny module ID id_UD ID string upload data module used handle uploads name list element react_state data set stored. id_DW ID string data wrangling module process uploaded data session Shiny session variable","code":""},{"path":"/reference/FG_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize FG Module State — FG_init_state","text":"list containing empty app state object","code":""},{"path":"/reference/FG_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize FG Module State — FG_init_state","text":"","code":"# These would be the Shiny input and session variables input = list() session = list() state = FG_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"FG.yaml\"), id = \"FG\", id_UD = \"UD\", id_DW = \"DW\", session = session) #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] TRUE #> #> $MC$compact$preview #> [1] \"ggplot\" #> #> $MC$compact$clip #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] TRUE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$components #> $MC$tooltips$components$manual #> $MC$tooltips$components$manual$x #> [1] \"Numeric location on the x-axis\" #> #> $MC$tooltips$components$manual$y #> [1] \"Numeric location on the y-axis\" #> #> $MC$tooltips$components$manual$color #> [1] \"A named color red, blue, green\" #> #> $MC$tooltips$components$manual$linetype #> [1] \"Specify either solid, dashed, dotted, dotdash, longdash or twodash\" #> #> $MC$tooltips$components$manual$shape #> [1] \"Open shapes: square (0), circle (1), triangle (2); Filled shapes: square (15), circle (16), triangle (17)\" #> #> $MC$tooltips$components$manual$size #> [1] \"Numeric value\" #> #> $MC$tooltips$components$manual$alpha #> [1] \"Numeric value between 0 (completely transparent) and 1 (solid)\" #> #> $MC$tooltips$components$manual$group #> NULL #> #> $MC$tooltips$components$manual$xintercept #> NULL #> #> $MC$tooltips$components$manual$yintercept #> NULL #> #> #> #> $MC$tooltips$ph #> $MC$tooltips$ph$notes #> [1] \"Optional figure notes that will be carried over and used in other elements (e.g. reporting).\" #> #> $MC$tooltips$ph$fig_key #> [1] \"Unique description used for referencing figures and in other elements (e.g. reporting).\" #> #> #> $MC$tooltips$show_code #> [1] \"Show figure generation code\" #> #> $MC$tooltips$fg_elements #> [1] \"Current figure elements\" #> #> #> $MC$labels #> $MC$labels$components #> $MC$labels$components$x #> [1] \"x-axis\" #> #> $MC$labels$components$y #> [1] \"y-axis\" #> #> $MC$labels$components$color #> [1] \"color\" #> #> $MC$labels$components$linetype #> [1] \"line type\" #> #> $MC$labels$components$fill #> [1] \"fill color\" #> #> $MC$labels$components$weight #> [1] \"weight\" #> #> $MC$labels$components$ymin #> [1] \"ymin\" #> #> $MC$labels$components$ymax #> [1] \"ymax\" #> #> $MC$labels$components$lower #> [1] \"lower\" #> #> $MC$labels$components$middle #> [1] \"middle\" #> #> $MC$labels$components$upper #> [1] \"upper\" #> #> $MC$labels$components$shape #> [1] \"shape\" #> #> $MC$labels$components$size #> [1] \"size\" #> #> $MC$labels$components$alpha #> [1] \"transparency\" #> #> $MC$labels$components$group #> [1] \"group\" #> #> $MC$labels$components$xintercept #> [1] \"x intercept\" #> #> $MC$labels$components$yintercept #> [1] \"y intercept\" #> #> $MC$labels$components$yscale #> [1] \"y-scale\" #> #> $MC$labels$components$xscale #> [1] \"x-scale\" #> #> $MC$labels$components$ylim #> [1] \"y limits\" #> #> $MC$labels$components$xlim #> [1] \"x limits\" #> #> #> $MC$labels$ph #> $MC$labels$ph$xlab #> [1] \"x-axis label\" #> #> $MC$labels$ph$ylab #> [1] \"y-axis label\" #> #> $MC$labels$ph$ggtitle #> [1] \"plot title\" #> #> $MC$labels$ph$notes #> [1] \"optional notes here\" #> #> $MC$labels$ph$fig_key #> [1] \"title/caption\" #> #> $MC$labels$ph$manual #> [1] \"Manual\" #> #> $MC$labels$ph$axlim #> [1] \"0.1, 1000 # Empty for auto\" #> #> #> $MC$labels$manual #> [1] \"Manual\" #> #> $MC$labels$not_used #> [1] \"Not Used\" #> #> $MC$labels$curr_figs_none #> [1] \"No figures yet created\" #> #> $MC$labels$no_fig_elements #> [1] \"Add figure elements\" #> #> $MC$labels$new_fig #> [1] \"New\" #> #> $MC$labels$save_fig #> [1] \"Save\" #> #> $MC$labels$del_fig #> [1] \"Delete\" #> #> $MC$labels$copy_fig #> [1] \"Copy\" #> #> $MC$labels$clip_fig #> [1] \"Code\" #> #> $MC$labels$upds_fig #> [1] \"Data set\" #> #> $MC$labels$add_ele #> [1] \"Add Figure Element\" #> #> $MC$labels$msg_bad_label #> [1] \"No labels were specified, unable to add element.\" #> #> $MC$labels$msg_bad_facet #> [1] \"At least one column must be selected to add a faceting element.\" #> #> $MC$labels$msg_bad_element #> [1] \"Unable to add the specified element: ===ELEMENT===\" #> #> $MC$labels$msg_bad_manual_comp #> [1] \"The plot element component ===COMP=== was specified manually but \\nno manual value was provided.\" #> #> $MC$labels$select_current_fig #> [1] \"Current figure\" #> #> $MC$labels$select_current_view #> [1] \"Data from\" #> #> $MC$labels$no_figures_defined #> [1] \"No figures have been defined. There are no data sources to create figures. You need to load data and create data views to use this module.\" #> #> $MC$labels$busy #> $MC$labels$busy$fig_update #> [1] \"Updating the current figure. Please be patient...\" #> #> #> #> $MC$errors #> $MC$errors$element_not_added #> [1] \"Unable to add the data figure element:\" #> #> $MC$errors$current_key_empty #> [1] \"The figure description field cannot be empty.\" #> #> $MC$errors$only_one_element #> [1] \"Only one element of ===ELEMENT=== type is allowed. The old ===ELEMENT=== will be replaced.\" #> #> #> $MC$elements #> $MC$elements$line #> $MC$elements$line$choice #> [1] \"Line\" #> #> $MC$elements$line$subtext #> [1] \"Continuous line\" #> #> $MC$elements$line$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"linetype\" \"size\" \"alpha\" #> #> $MC$elements$line$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$line$fcn #> [1] \"geom_line\" #> #> #> $MC$elements$point #> $MC$elements$point$choice #> [1] \"Point\" #> #> $MC$elements$point$subtext #> [1] \"Scatter plot\" #> #> $MC$elements$point$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"shape\" \"size\" \"alpha\" #> #> $MC$elements$point$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$point$fcn #> [1] \"geom_point\" #> #> #> $MC$elements$errorbar #> $MC$elements$errorbar$choice #> [1] \"Errobar\" #> #> $MC$elements$errorbar$subtext #> [1] \"Errorbars around points\" #> #> $MC$elements$errorbar$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"size\" \"alpha\" #> #> $MC$elements$errorbar$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$errorbar$fcn #> [1] \"geom_errorbar\" #> #> #> $MC$elements$hguide #> $MC$elements$hguide$choice #> [1] \"H-Guide\" #> #> $MC$elements$hguide$subtext #> [1] \"Horizontal guide\" #> #> $MC$elements$hguide$ui_aes #> [1] \"yintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$hguide$aes_req #> [1] \"yintercept\" #> #> $MC$elements$hguide$fcn #> [1] \"geom_hline\" #> #> #> $MC$elements$vguide #> $MC$elements$vguide$choice #> [1] \"V-Guide\" #> #> $MC$elements$vguide$subtext #> [1] \"Vertical guide\" #> #> $MC$elements$vguide$ui_aes #> [1] \"xintercept\" \"linetype\" \"color\" \"size\" #> #> $MC$elements$vguide$aes_req #> [1] \"xintercept\" #> #> $MC$elements$vguide$fcn #> [1] \"geom_vline\" #> #> #> $MC$elements$facet #> $MC$elements$facet$choice #> [1] \"Facet\" #> #> $MC$elements$facet$subtext #> [1] \"Facet by one or more variables\" #> #> #> $MC$elements$label #> $MC$elements$label$choice #> [1] \"Label\" #> #> $MC$elements$label$subtext #> [1] \"Label axes or plot title\" #> #> $MC$elements$label$ui_text #> [1] \"xlab\" \"ylab\" \"ggtitle\" #> #> #> $MC$elements$scales #> $MC$elements$scales$choice #> [1] \"Format Axes\" #> #> $MC$elements$scales$subtext #> [1] \"Axis scales and limits\" #> #> #> $MC$elements$smooth #> $MC$elements$smooth$choice #> [1] \"Smooth Trend\" #> #> $MC$elements$smooth$subtext #> [1] \"Smoothed conditional means\" #> #> $MC$elements$smooth$ui_aes #> [1] \"x\" \"y\" \"color\" \"group\" \"fill\" \"weight\" #> [7] \"linetype\" \"size\" \"alpha\" \"ymax\" \"ymin\" #> #> $MC$elements$smooth$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$smooth$fcn #> [1] \"geom_smooth\" #> #> #> $MC$elements$ribbon #> $MC$elements$ribbon$choice #> [1] \"Shaded Area\" #> #> $MC$elements$ribbon$subtext #> [1] \"Creating prediction intervals\" #> #> $MC$elements$ribbon$ui_aes #> [1] \"x\" \"ymin\" \"ymax\" \"color\" \"group\" \"fill\" \"linetype\" #> [8] \"size\" \"alpha\" #> #> $MC$elements$ribbon$aes_req #> [1] \"x\" \"ymin\" \"ymax\" #> #> $MC$elements$ribbon$fcn #> [1] \"geom_ribbon\" #> #> #> $MC$elements$boxplot #> $MC$elements$boxplot$choice #> [1] \"Boxplot\" #> #> $MC$elements$boxplot$subtext #> [1] \"Box and whiskers plot\" #> #> $MC$elements$boxplot$ui_aes #> [1] \"x\" \"y\" \"lower\" \"middle\" \"upper\" \"ymin\" #> [7] \"ymax\" \"color\" \"group\" \"fill\" \"weight\" \"linetype\" #> [13] \"size\" \"shape\" \"alpha\" #> #> $MC$elements$boxplot$aes_req #> [1] \"x\" \"y\" #> #> $MC$elements$boxplot$fcn #> [1] \"geom_boxplot\" #> #> #> #> $MC$formatting #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 800 #> #> $MC$formatting$code$height #> [1] 300 #> #> #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 400 #> #> #> $MC$formatting$select_fg_page #> $MC$formatting$select_fg_page$width #> [1] 1000 #> #> #> $MC$formatting$notes #> $MC$formatting$notes$width #> [1] \"560px\" #> #> $MC$formatting$notes$height #> [1] \"75px\" #> #> #> $MC$formatting$components #> $MC$formatting$components$aes #> $MC$formatting$components$aes$width #> [1] \"100px\" #> #> #> $MC$formatting$components$facet #> $MC$formatting$components$facet$width #> [1] \"200px\" #> #> #> $MC$formatting$components$label #> $MC$formatting$components$label$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axscale #> $MC$formatting$components$axscale$width #> [1] \"150px\" #> #> #> $MC$formatting$components$axlim #> $MC$formatting$components$axlim$width #> [1] \"150px\" #> #> #> #> $MC$formatting$select_current_fig #> $MC$formatting$select_current_fig$width #> [1] 200 #> #> #> $MC$formatting$select_current_view #> $MC$formatting$select_current_view$width #> [1] 200 #> #> #> $MC$formatting$fg_elements #> $MC$formatting$fg_elements$width #> [1] 600 #> #> $MC$formatting$fg_elements$height #> [1] 200 #> #> #> $MC$formatting$faceting #> $MC$formatting$faceting$nrow #> [1] 3 #> #> $MC$formatting$faceting$ncol #> [1] 4 #> #> #> $MC$formatting$button_fig_del #> $MC$formatting$button_fig_del$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_del$block #> [1] TRUE #> #> $MC$formatting$button_fig_del$tooltip #> [1] \"Delete the current figure.\" #> #> $MC$formatting$button_fig_del$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_save #> $MC$formatting$button_fig_save$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_save$block #> [1] TRUE #> #> $MC$formatting$button_fig_save$tooltip #> [1] \"Save changes to caption, notes and data source.\" #> #> $MC$formatting$button_fig_save$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_clip #> $MC$formatting$button_fig_clip$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_clip$block #> [1] TRUE #> #> $MC$formatting$button_fig_clip$tooltip #> [1] \"Copy code to generate current figure to the clipboard.\" #> #> $MC$formatting$button_fig_clip$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_copy #> $MC$formatting$button_fig_copy$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_copy$block #> [1] TRUE #> #> $MC$formatting$button_fig_copy$tooltip #> [1] \"Copy current figure to a new figure.\" #> #> $MC$formatting$button_fig_copy$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_new #> $MC$formatting$button_fig_new$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_new$block #> [1] TRUE #> #> $MC$formatting$button_fig_new$tooltip #> [1] \"Create a new empty figure.\" #> #> $MC$formatting$button_fig_new$tooltip_position #> [1] \"right\" #> #> #> $MC$formatting$button_fig_add #> $MC$formatting$button_fig_add$size #> [1] \"sm\" #> #> $MC$formatting$button_fig_add$block #> [1] TRUE #> #> #> #> $MC$post_processing #> [1] \"===FGOBJ=== = ===FGOBJ=== + ggplot2::theme_light()\" #> #> $MC$fg_object_name #> [1] \"myp\" #> #> $MC$code #> $MC$code$packages #> [1] \"ggplot2\" \"ggforce\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Generating figures ------------------------------------------------------\" #> #> #> #> $FG #> $FG$button_counters #> $FG$button_counters$button_element_add #> [1] 0 #> #> $FG$button_counters$button_fig_save #> [1] 0 #> #> $FG$button_counters$button_fig_new #> [1] 0 #> #> $FG$button_counters$button_fig_del #> [1] 0 #> #> $FG$button_counters$button_fig_copy #> [1] 0 #> #> #> $FG$ui_hold #> $FG$ui_hold$hot_fg_elements #> [1] FALSE #> #> $FG$ui_hold$text_fig_key #> [1] FALSE #> #> $FG$ui_hold$text_fig_notes #> [1] FALSE #> #> $FG$ui_hold$select_current_view #> [1] FALSE #> #> $FG$ui_hold$select_current_fig #> [1] FALSE #> #> #> $FG$ui_ids #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" \"text_component_x_manual\" #> [9] \"text_component_y_manual\" \"text_component_color_manual\" #> [11] \"text_component_group_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_alpha_manual\" #> [15] \"select_component_shape\" \"text_component_shape_manual\" #> [17] \"select_component_ymin\" \"select_component_ymax\" #> [19] \"text_component_ymin_manual\" \"text_component_ymax_manual\" #> [21] \"select_component_yintercept\" \"text_component_yintercept_manual\" #> [23] \"select_component_xintercept\" \"text_component_xintercept_manual\" #> [25] \"select_component_fill\" \"select_component_weight\" #> [27] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [29] \"select_component_lower\" \"select_component_middle\" #> [31] \"select_component_upper\" \"text_component_lower_manual\" #> [33] \"text_component_middle_manual\" \"text_component_upper_manual\" #> [35] \"button_fig_new\" \"button_fig_save\" #> [37] \"button_fig_del\" \"button_fig_copy\" #> [39] \"button_element_add\" \"hot_fg_elements\" #> [41] \"text_fig_key\" \"text_fig_notes\" #> [43] \"text_component_xlab\" \"text_component_ylab\" #> [45] \"text_component_xlim\" \"text_component_ylim\" #> [47] \"text_component_ggtitle\" \"select_fg_page\" #> [49] \"select_current_fig\" \"select_current_view\" #> [51] \"select_component_facet\" \"select_component_xscale\" #> [53] \"select_component_yscale\" \"select_fg_element\" #> #> $FG$isgood #> [1] FALSE #> #> $FG$DSV #> $FG$DSV$isgood #> [1] FALSE #> #> $FG$DSV$hasds #> [1] FALSE #> #> $FG$DSV$catalog #> NULL #> #> $FG$DSV$modules #> list() #> #> $FG$DSV$ds #> list() #> #> #> $FG$fig_cntr #> [1] 0 #> #> $FG$aes_elements #> [1] \"line\" \"point\" \"errorbar\" \"hguide\" \"vguide\" \"smooth\" \"ribbon\" #> [8] \"boxplot\" #> #> $FG$auto_elements #> $FG$auto_elements$line #> $FG$auto_elements$line$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_linetype\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$line$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$point #> $FG$auto_elements$point$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" \"select_component_color\" #> [4] \"select_component_group\" \"select_component_shape\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$point$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_shape_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$errorbar #> $FG$auto_elements$errorbar$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" \"select_component_ymax\" #> [4] \"select_component_color\" \"select_component_group\" \"select_component_size\" #> [7] \"select_component_alpha\" #> #> $FG$auto_elements$errorbar$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_size_manual\" #> [7] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$hguide #> $FG$auto_elements$hguide$ui_aes_select_id #> [1] \"select_component_yintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$hguide$ui_aes_manual_id #> [1] \"text_component_yintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$vguide #> $FG$auto_elements$vguide$ui_aes_select_id #> [1] \"select_component_xintercept\" \"select_component_linetype\" #> [3] \"select_component_color\" \"select_component_size\" #> #> $FG$auto_elements$vguide$ui_aes_manual_id #> [1] \"text_component_xintercept_manual\" \"text_component_linetype_manual\" #> [3] \"text_component_color_manual\" \"text_component_size_manual\" #> #> #> $FG$auto_elements$smooth #> $FG$auto_elements$smooth$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_color\" \"select_component_group\" #> [5] \"select_component_fill\" \"select_component_weight\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" \"select_component_ymax\" #> [11] \"select_component_ymin\" #> #> $FG$auto_elements$smooth$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_color_manual\" \"text_component_group_manual\" #> [5] \"text_component_fill_manual\" \"text_component_weight_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" \"text_component_ymax_manual\" #> [11] \"text_component_ymin_manual\" #> #> #> $FG$auto_elements$ribbon #> $FG$auto_elements$ribbon$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_ymin\" #> [3] \"select_component_ymax\" \"select_component_color\" #> [5] \"select_component_group\" \"select_component_fill\" #> [7] \"select_component_linetype\" \"select_component_size\" #> [9] \"select_component_alpha\" #> #> $FG$auto_elements$ribbon$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_ymin_manual\" #> [3] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [5] \"text_component_group_manual\" \"text_component_fill_manual\" #> [7] \"text_component_linetype_manual\" \"text_component_size_manual\" #> [9] \"text_component_alpha_manual\" #> #> #> $FG$auto_elements$boxplot #> $FG$auto_elements$boxplot$ui_aes_select_id #> [1] \"select_component_x\" \"select_component_y\" #> [3] \"select_component_lower\" \"select_component_middle\" #> [5] \"select_component_upper\" \"select_component_ymin\" #> [7] \"select_component_ymax\" \"select_component_color\" #> [9] \"select_component_group\" \"select_component_fill\" #> [11] \"select_component_weight\" \"select_component_linetype\" #> [13] \"select_component_size\" \"select_component_shape\" #> [15] \"select_component_alpha\" #> #> $FG$auto_elements$boxplot$ui_aes_manual_id #> [1] \"text_component_x_manual\" \"text_component_y_manual\" #> [3] \"text_component_lower_manual\" \"text_component_middle_manual\" #> [5] \"text_component_upper_manual\" \"text_component_ymin_manual\" #> [7] \"text_component_ymax_manual\" \"text_component_color_manual\" #> [9] \"text_component_group_manual\" \"text_component_fill_manual\" #> [11] \"text_component_weight_manual\" \"text_component_linetype_manual\" #> [13] \"text_component_size_manual\" \"text_component_shape_manual\" #> [15] \"text_component_alpha_manual\" #> #> #> #> #> $MOD_TYPE #> [1] \"FG\" #> #> $id #> [1] \"FG\" #> #> $dep_mod_ids #> [1] \"UD\" \"DW\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/FG.yaml\" #>"},{"path":"/reference/FG_new_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize New Figure — FG_new_fig","title":"Initialize New Figure — FG_new_fig","text":"Creates new figure FG module","code":""},{"path":"/reference/FG_new_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize New Figure — FG_new_fig","text":"","code":"FG_new_fig(state)"},{"path":"/reference/FG_new_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize New Figure — FG_new_fig","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/FG_new_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize New Figure — FG_new_fig","text":"FG state object containing new empty figure figure set current active figure","code":""},{"path":"/reference/FG_new_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize New Figure — FG_new_fig","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:96db745c38408478cb1788f44905a48a"},{"path":"/reference/FG_set_current_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Current Figure — FG_set_current_fig","title":"Sets Current Figure — FG_set_current_fig","text":"Takes FG state figure list sets figure list value active figure","code":""},{"path":"/reference/FG_set_current_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Current Figure — FG_set_current_fig","text":"","code":"FG_set_current_fig(state, fig)"},{"path":"/reference/FG_set_current_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Current Figure — FG_set_current_fig","text":"state FG state FG_fetch_state() fig Figure list FG_fetch_current_fig","code":""},{"path":"/reference/FG_set_current_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Current Figure — FG_set_current_fig","text":"State current figure updated","code":""},{"path":"/reference/FG_set_current_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Current Figure — FG_set_current_fig","text":"","code":"library(formods) # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This sets the current active figure to Fig_1 state[[\"FG\"]][[\"current_fig\"]] = \"Fig_1\" # This is a paginated figure, and we can access a specific # figure using the following: pg_1 = FG_extract_page(state, 1) pg_2 = FG_extract_page(state, 2) # This will give you access to the current figure directly: current_fig = FG_fetch_current_fig(state) # For example this will set the key for that figure: current_fig$key = \"Individual profiles by cohort (multiple pages)\" # Once you're done you can put it back into the state: state = FG_set_current_fig(state, current_fig) # If you made any changes to the actual figure, this will # force a rebuild of the current figure: state = FG_build( state=state, del_row = NULL, cmd = NULL) #> → FG: module checksum updated:10e425a7019254cbf1c6d86392dd12dd # To create a new empty figure you can do this: state = FG_new_fig(state) #> → FG: module checksum updated:96db745c38408478cb1788f44905a48a"},{"path":"/reference/FG_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — FG_test_mksession","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/FG_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"","code":"FG_test_mksession( session, id = \"FG\", id_UD = \"UD\", id_DW = \"DW\", full_session = TRUE )"},{"path":"/reference/FG_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements id_UD ID string corresponds ID used call UD modules UI elements id_DW ID string corresponds ID used call DW modules UI elements full_session Boolean indicate full test session created (default TRUE).","code":""},{"path":"/reference/FG_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/FG_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — FG_test_mksession","text":"","code":"sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255"},{"path":"/reference/FG_update_checksum.html","id":null,"dir":"Reference","previous_headings":"","what":"Updates FG Module Checksum — FG_update_checksum","title":"Updates FG Module Checksum — FG_update_checksum","text":"Called changes figures, function update checksum module. allows modules determine changes figures within .","code":""},{"path":"/reference/FG_update_checksum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Updates FG Module Checksum — FG_update_checksum","text":"","code":"FG_update_checksum(state)"},{"path":"/reference/FG_update_checksum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Updates FG Module Checksum — FG_update_checksum","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/FG_update_checksum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Updates FG Module Checksum — FG_update_checksum","text":"state checksum updated.","code":""},{"path":"/reference/FG_update_checksum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Updates FG Module Checksum — FG_update_checksum","text":"","code":"# This will create a populated FG state object: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 state = sess_res$state state = FG_update_checksum(state) #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255"},{"path":"/reference/FM_add_ui_tooltip.html","id":null,"dir":"Reference","previous_headings":"","what":"Add Tooltip to UI Element — FM_add_ui_tooltip","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"Adds tool tip user element.","code":""},{"path":"/reference/FM_add_ui_tooltip.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"","code":"FM_add_ui_tooltip( state, uiele, tooltip = \"mytooltip\", position = \"right\", size = \"medium\" )"},{"path":"/reference/FM_add_ui_tooltip.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"state Current module state yaml file read. uiele UI element add toooltip . tooltip Text containing tool tip. position Position tooltip. size size tooltip","code":""},{"path":"/reference/FM_add_ui_tooltip.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"tooltips enabled suggested packages installed uiele tooltip added returned. Otherwise just return original uiele unchanged.","code":""},{"path":"/reference/FM_add_ui_tooltip.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add Tooltip to UI Element — FM_add_ui_tooltip","text":"","code":"if(interactive()){ # We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) state = sess_res$state uiele = shiny::textInput(inputId = \"my input\", label=\"example input\") uiele = FM_add_ui_tooltip(state, uiele) }"},{"path":"/reference/FM_build_comment.html","id":null,"dir":"Reference","previous_headings":"","what":"Create RStudio Formatted Comments — FM_build_comment","title":"Create RStudio Formatted Comments — FM_build_comment","text":"Takes character string builds comment formatted section specified level RStudio","code":""},{"path":"/reference/FM_build_comment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create RStudio Formatted Comments — FM_build_comment","text":"","code":"FM_build_comment(level = 1, comment_str)"},{"path":"/reference/FM_build_comment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create RStudio Formatted Comments — FM_build_comment","text":"level Integer (1 (default),2, 3) indicating section level comment. comment_str Character object.","code":""},{"path":"/reference/FM_build_comment.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create RStudio Formatted Comments — FM_build_comment","text":"Formatted comment.","code":""},{"path":"/reference/FM_build_comment.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create RStudio Formatted Comments — FM_build_comment","text":"","code":"FM_build_comment(1, \"This is a level 1 header\") #> [1] \"# This is a level 1 header ------------------------------------------------\" FM_build_comment(2, paste0(rep(\"Long string repeated.\", 5), collapse=\" \")) #> [1] \"# Long string repeated. Long string repeated. Long string repeated. L =====\""},{"path":"/reference/FM_fetch_app_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"Takes current state app builds script reproduce analysis within app.","code":""},{"path":"/reference/FM_fetch_app_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"","code":"FM_fetch_app_code(session, state, mod_ids)"},{"path":"/reference/FM_fetch_app_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"session Shiny session variable state module state yaml read mod_ids Vector module IDs order needed (used code generation).","code":""},{"path":"/reference/FM_fetch_app_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"list following elements: isgood: Boolean indicating whether code generation successful (TRUE) msgs: messages generated code: Code regenerate app","code":""},{"path":"/reference/FM_fetch_app_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Code to Reproduce Analysis — FM_fetch_app_code","text":"","code":"# We need a Shiny session object to use this function: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session state = sess_res$state app_code = FM_fetch_app_code(session = session, state = state, mod_ids = c(\"UD\", \"DW\")) cat(app_code$code) #> # formods automated output ------------------------------------------------ #> # https://formods.ubiquity.tools/ #> rm(list=ls()) #> library(\"dplyr\") #> library(\"janitor\") #> library(\"readr\") #> library(\"readxl\") #> library(\"tidyr\") #> #> #> # This reporting object has the formatting #> # information for table generation #> rpt = onbrand::read_template( #> template = file.path(\"config\", \"report.docx\"), #> mapping = file.path(\"config\", \"report.yaml\")) #> #> # Loading data ------------------------------------------------------------ #> myDS = readxl::read_excel(path=\"TEST_DATA.xlsx\", sheet=\"DATA\") #> myDS = janitor::clean_names(myDS, case=\"none\") #> #> # Data wrangling ---------------------------------------------------------- #> # Observations ============================================================ #> DW_myDS_1 = myDS #> DW_myDS_1 = dplyr::filter(DW_myDS_1,EVID == 0) #> DW_myDS_1 = dplyr::filter(DW_myDS_1,DV != 0) #> DW_myDS_1 = dplyr::mutate(DW_myDS_1,IDCMT = paste0(ID, ', ', CMT)) #> #> # PK 3mg SD IV ============================================================ #> DW_myDS_2 = myDS #> DW_myDS_2 = dplyr::filter(DW_myDS_2,EVID == 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,DV != 0) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_2 = dplyr::filter(DW_myDS_2,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg MD SC (first dose) =============================================== #> DW_myDS_3 = myDS #> DW_myDS_3 = dplyr::filter(DW_myDS_3,EVID == 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DV != 0) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,DOSE_NUM == 1) #> DW_myDS_3 = dplyr::filter(DW_myDS_3,CMT %in% c(\"C_ng_ml\")) #> #> # Parameters ============================================================== #> DW_myDS_4 = myDS #> DW_myDS_4 = dplyr::group_by(DW_myDS_4,ID) #> DW_myDS_4 = dplyr::filter(DW_myDS_4,row_number()==1) #> DW_myDS_4 = dplyr::select(DW_myDS_4,ID, DOSE, DOSE_STR, Cohort, ROUTE, ka, CL, Vc, Vp, Q) #> DW_myDS_4 = tidyr::pivot_longer(DW_myDS_4, cols = c(\"ka\", \"CL\", \"Vc\", \"Vp\", \"Q\"), names_to = \"parameter\", values_to = \"values\") #> #> # PK/PD 3mg SD IV w/BQL =================================================== #> DW_myDS_5 = myDS #> DW_myDS_5 = dplyr::filter(DW_myDS_5,EVID == 0) #> DW_myDS_5 = dplyr::filter(DW_myDS_5,Cohort %in% c(\"SD 3 mg IV\")) #> #> # PK/PD 3mg MD SC (first dose) w/BQL ====================================== #> DW_myDS_6 = myDS #> DW_myDS_6 = dplyr::filter(DW_myDS_6,EVID == 0) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,Cohort %in% c(\"MD 3 mg SC\")) #> DW_myDS_6 = dplyr::filter(DW_myDS_6,DOSE_NUM == 1) #> #> # PK 3mg SD IV w/BQL ====================================================== #> DW_myDS_7 = myDS #> DW_myDS_7 = dplyr::filter(DW_myDS_7,EVID == 0) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,Cohort %in% c(\"SD 3 mg IV\")) #> DW_myDS_7 = dplyr::filter(DW_myDS_7,CMT %in% c(\"C_ng_ml\")) #> #> # PK 3mg SD IV w/BQL w/dosing ============================================= #> DW_myDS_8 = myDS #> DW_myDS_8 = dplyr::filter(DW_myDS_8,Cohort %in% c(\"MD 3 mg IV\")) #>"},{"path":"/reference/FM_fetch_app_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Informaiton About the App — FM_fetch_app_info","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"Returns diagnostic information app","code":""},{"path":"/reference/FM_fetch_app_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"","code":"FM_fetch_app_info(session)"},{"path":"/reference/FM_fetch_app_info.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"session Shiny session variable.","code":""},{"path":"/reference/FM_fetch_app_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"List information app following structure uiele: system information UI elements used shiny apps. uiele_packages: UI element installed packages used shiny apps. uiele_options: UI element current options. uiele_modules: UI element loaded formods modules used shiny apps. msgs: System information text used report/terminal. si_packages Dataframe currently used packages. si_options Dataframe current options","code":""},{"path":"/reference/FM_fetch_app_info.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Informaiton About the App — FM_fetch_app_info","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session app_info = FM_fetch_app_info(session) app_info$msgs #> [1] \"Modules\" #> [2] \"ID: UD\" #> [3] \"type: UD\" #> [4] \"FM_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> [5] \"MOD_yaml_file: /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml\" #> [6] \"User files: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM\" #> [7] \"Log file: /var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/formods_log.txt\" #> [8] \"Package dependencies: janitor, readr, readxl\" #> [9] \" package * version date (UTC) lib source\" #> [10] \" abind 1.4-5 2016-07-21 [2] CRAN (R 4.2.0)\" #> [11] \" askpass 1.1 2019-01-13 [2] CRAN (R 4.2.0)\" #> [12] \" backports 1.4.1 2021-12-13 [2] CRAN (R 4.2.0)\" #> [13] \" broom 1.0.4 2023-03-11 [2] CRAN (R 4.2.0)\" #> [14] \" bslib 0.4.2 2022-12-16 [2] CRAN (R 4.2.0)\" #> [15] \" cachem 1.0.7 2023-02-24 [2] CRAN (R 4.2.0)\" #> [16] \" callr 3.7.3 2022-11-02 [2] CRAN (R 4.2.0)\" #> [17] \" car 3.1-2 2023-03-30 [2] CRAN (R 4.2.1)\" #> [18] \" carData 3.0-5 2022-01-06 [2] CRAN (R 4.2.0)\" #> [19] \" cellranger 1.1.0 2016-07-27 [2] CRAN (R 4.2.0)\" #> [20] \" cli 3.6.1 2023-03-23 [2] CRAN (R 4.2.0)\" #> [21] \" clipr 0.8.0 2022-02-22 [2] CRAN (R 4.2.0)\" #> [22] \" colorspace 2.1-0 2023-01-23 [2] CRAN (R 4.2.0)\" #> [23] \" crayon 1.5.2 2022-09-29 [2] CRAN (R 4.2.0)\" #> [24] \" crul 1.3 2022-09-03 [2] CRAN (R 4.2.0)\" #> [25] \" curl 5.0.0 2023-01-12 [2] CRAN (R 4.2.0)\" #> [26] \" data.table 1.14.8 2023-02-17 [2] CRAN (R 4.2.0)\" #> [27] \" desc 1.4.2 2022-09-08 [2] CRAN (R 4.2.0)\" #> [28] \" devtools 2.4.5 2022-10-11 [2] CRAN (R 4.2.0)\" #> [29] \" digest 0.6.31 2022-12-11 [2] CRAN (R 4.2.0)\" #> [30] \" downlit 0.4.2 2022-07-05 [2] CRAN (R 4.2.0)\" #> [31] \" dplyr 1.1.1 2023-03-22 [2] CRAN (R 4.2.0)\" #> [32] \" ellipsis 0.3.2 2021-04-29 [2] CRAN (R 4.2.0)\" #> [33] \" evaluate 0.20 2023-01-17 [2] CRAN (R 4.2.0)\" #> [34] \" fansi 1.0.4 2023-01-22 [2] CRAN (R 4.2.0)\" #> [35] \" farver 2.1.1 2022-07-06 [2] CRAN (R 4.2.0)\" #> [36] \" fastmap 1.1.1 2023-02-24 [2] CRAN (R 4.2.0)\" #> [37] \" flextable 0.9.1 2023-04-02 [2] CRAN (R 4.2.1)\" #> [38] \" fontBitstreamVera 0.1.1 2017-02-01 [2] CRAN (R 4.2.0)\" #> [39] \" fontLiberation 0.1.0 2016-10-15 [2] CRAN (R 4.2.0)\" #> [40] \" fontquiver 0.2.1 2017-02-01 [2] CRAN (R 4.2.0)\" #> [41] \" formods * 0.1.2 2023-11-23 [1] local\" #> [42] \" fs 1.6.1 2023-02-06 [2] CRAN (R 4.2.0)\" #> [43] \" gdtools 0.3.3 2023-03-27 [2] CRAN (R 4.2.1)\" #> [44] \" generics 0.1.3 2022-07-05 [2] CRAN (R 4.2.0)\" #> [45] \" gfonts 0.2.0 2023-01-08 [2] CRAN (R 4.2.0)\" #> [46] \" ggforce 0.4.1 2022-10-04 [2] CRAN (R 4.2.0)\" #> [47] \" ggplot2 3.4.2 2023-04-03 [2] CRAN (R 4.2.0)\" #> [48] \" ggpubr 0.6.0 2023-02-10 [2] CRAN (R 4.2.0)\" #> [49] \" ggsignif 0.6.4 2022-10-13 [2] CRAN (R 4.2.0)\" #> [50] \" glue 1.6.2 2022-02-24 [2] CRAN (R 4.2.0)\" #> [51] \" gtable 0.3.3 2023-03-21 [2] CRAN (R 4.2.0)\" #> [52] \" hms 1.1.3 2023-03-21 [2] CRAN (R 4.2.0)\" #> [53] \" htmltools 0.5.5 2023-03-23 [2] CRAN (R 4.2.0)\" #> [54] \" htmlwidgets 1.6.2 2023-03-17 [2] CRAN (R 4.2.0)\" #> [55] \" httpcode 0.3.0 2020-04-10 [2] CRAN (R 4.2.0)\" #> [56] \" httpuv 1.6.9 2023-02-14 [2] CRAN (R 4.2.0)\" #> [57] \" httr 1.4.5 2023-02-24 [2] CRAN (R 4.2.0)\" #> [58] \" janitor 2.2.0 2023-02-02 [2] CRAN (R 4.2.0)\" #> [59] \" jquerylib 0.1.4 2021-04-26 [2] CRAN (R 4.2.0)\" #> [60] \" jsonlite 1.8.4 2022-12-06 [2] CRAN (R 4.2.0)\" #> [61] \" knitr 1.42 2023-01-25 [2] CRAN (R 4.2.0)\" #> [62] \" labeling 0.4.2 2020-10-20 [2] CRAN (R 4.2.0)\" #> [63] \" later 1.3.0 2021-08-18 [2] CRAN (R 4.2.0)\" #> [64] \" lazyeval 0.2.2 2019-03-15 [2] CRAN (R 4.2.0)\" #> [65] \" lifecycle 1.0.3 2022-10-07 [2] CRAN (R 4.2.0)\" #> [66] \" lubridate 1.9.2 2023-02-10 [2] CRAN (R 4.2.0)\" #> [67] \" magrittr 2.0.3 2022-03-30 [2] CRAN (R 4.2.0)\" #> [68] \" MASS 7.3-58.2 2023-01-23 [2] CRAN (R 4.2.0)\" #> [69] \" memoise 2.0.1 2021-11-26 [2] CRAN (R 4.2.0)\" #> [70] \" mime 0.12 2021-09-28 [2] CRAN (R 4.2.0)\" #> [71] \" miniUI 0.1.1.1 2018-05-18 [2] CRAN (R 4.2.0)\" #> [72] \" munsell 0.5.0 2018-06-12 [2] CRAN (R 4.2.0)\" #> [73] \" officer 0.6.2 2023-03-28 [2] CRAN (R 4.2.1)\" #> [74] \" onbrand 1.0.3 2023-07-16 [2] CRAN (R 4.2.0)\" #> [75] \" openssl 2.0.6 2023-03-09 [2] CRAN (R 4.2.0)\" #> [76] \" pillar 1.9.0 2023-03-22 [2] CRAN (R 4.2.0)\" #> [77] \" pkgbuild 1.4.0 2022-11-27 [2] CRAN (R 4.2.0)\" #> [78] \" pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.2.0)\" #> [79] \" pkgdown 2.0.7 2022-12-14 [2] CRAN (R 4.2.0)\" #> [80] \" pkgload 1.3.2 2022-11-16 [2] CRAN (R 4.2.0)\" #> [81] \" plotly 4.10.1 2022-11-07 [2] CRAN (R 4.2.0)\" #> [82] \" polyclip 1.10-4 2022-10-20 [2] CRAN (R 4.2.1)\" #> [83] \" prettyunits 1.1.1 2020-01-24 [2] CRAN (R 4.2.0)\" #> [84] \" processx 3.8.0 2022-10-26 [2] CRAN (R 4.2.0)\" #> [85] \" profvis 0.3.7 2020-11-02 [2] CRAN (R 4.2.0)\" #> [86] \" promises 1.2.0.1 2021-02-11 [2] CRAN (R 4.2.0)\" #> [87] \" prompter 1.1.0 2021-10-07 [2] CRAN (R 4.2.0)\" #> [88] \" ps 1.7.4 2023-04-02 [2] CRAN (R 4.2.1)\" #> [89] \" purrr 1.0.1 2023-01-10 [2] CRAN (R 4.2.0)\" #> [90] \" R6 2.5.1 2021-08-19 [2] CRAN (R 4.2.0)\" #> [91] \" ragg 1.2.5 2023-01-12 [2] CRAN (R 4.2.0)\" #> [92] \" Rcpp 1.0.10 2023-01-22 [2] CRAN (R 4.2.0)\" #> [93] \" readr 2.1.4 2023-02-10 [2] CRAN (R 4.2.0)\" #> [94] \" readxl 1.4.2 2023-02-09 [2] CRAN (R 4.2.0)\" #> [95] \" remotes 2.4.2 2021-11-30 [2] CRAN (R 4.2.0)\" #> [96] \" rhandsontable 0.3.8 2021-05-27 [2] CRAN (R 4.2.0)\" #> [97] \" rlang 1.1.0 2023-03-14 [2] CRAN (R 4.2.0)\" #> [98] \" rmarkdown 2.21 2023-03-26 [2] CRAN (R 4.2.1)\" #> [99] \" rprojroot 2.0.3 2022-04-02 [2] CRAN (R 4.2.0)\" #> [100] \" rstatix 0.7.2 2023-02-01 [2] CRAN (R 4.2.0)\" #> [101] \" rstudioapi 0.14 2022-08-22 [2] CRAN (R 4.2.0)\" #> [102] \" sass 0.4.5 2023-01-24 [2] CRAN (R 4.2.0)\" #> [103] \" scales 1.2.1 2022-08-20 [2] CRAN (R 4.2.0)\" #> [104] \" sessioninfo 1.2.2 2021-12-06 [2] CRAN (R 4.2.0)\" #> [105] \" shiny 1.7.4 2022-12-15 [2] CRAN (R 4.2.0)\" #> [106] \" shinyAce 0.4.2 2022-05-06 [2] CRAN (R 4.2.0)\" #> [107] \" shinybusy 0.3.1 2022-05-10 [2] CRAN (R 4.2.0)\" #> [108] \" shinydashboard 0.7.2 2021-09-30 [2] CRAN (R 4.2.0)\" #> [109] \" shinyWidgets 0.8.0 2023-08-30 [2] CRAN (R 4.2.0)\" #> [110] \" snakecase 0.11.0 2019-05-25 [2] CRAN (R 4.2.0)\" #> [111] \" stringi 1.7.12 2023-01-11 [2] CRAN (R 4.2.0)\" #> [112] \" stringr 1.5.0 2022-12-02 [2] CRAN (R 4.2.0)\" #> [113] \" systemfonts 1.0.4 2022-02-11 [2] CRAN (R 4.2.0)\" #> [114] \" textshaping 0.3.6 2021-10-13 [2] CRAN (R 4.2.0)\" #> [115] \" tibble 3.2.1 2023-03-20 [2] CRAN (R 4.2.0)\" #> [116] \" tidyr 1.3.0 2023-01-24 [2] CRAN (R 4.2.0)\" #> [117] \" tidyselect 1.2.0 2022-10-10 [2] CRAN (R 4.2.0)\" #> [118] \" timechange 0.2.0 2023-01-11 [2] CRAN (R 4.2.0)\" #> [119] \" tweenr 2.0.2 2022-09-06 [2] CRAN (R 4.2.0)\" #> [120] \" tzdb 0.3.0 2022-03-28 [2] CRAN (R 4.2.0)\" #> [121] \" urlchecker 1.0.1 2021-11-30 [2] CRAN (R 4.2.0)\" #> [122] \" usethis 2.1.6 2022-05-25 [2] CRAN (R 4.2.0)\" #> [123] \" utf8 1.2.3 2023-01-31 [2] CRAN (R 4.2.0)\" #> [124] \" uuid 1.1-0 2022-04-19 [2] CRAN (R 4.2.0)\" #> [125] \" vctrs 0.6.1 2023-03-22 [2] CRAN (R 4.2.0)\" #> [126] \" viridisLite 0.4.1 2022-08-22 [2] CRAN (R 4.2.0)\" #> [127] \" whisker 0.4.1 2022-12-05 [2] CRAN (R 4.2.0)\" #> [128] \" withr 2.5.0 2022-03-03 [2] CRAN (R 4.2.0)\" #> [129] \" writexl 1.4.2 2023-01-06 [2] CRAN (R 4.2.0)\" #> [130] \" xfun 0.38 2023-03-24 [2] CRAN (R 4.2.0)\" #> [131] \" xml2 1.3.3 2021-11-30 [2] CRAN (R 4.2.0)\" #> [132] \" xtable 1.8-4 2019-04-21 [2] CRAN (R 4.2.0)\" #> [133] \" yaml 2.3.7 2023-01-23 [2] CRAN (R 4.2.0)\" #> [134] \" zip 2.2.2 2022-10-26 [2] CRAN (R 4.2.0)\" #> [135] \"\" #> [136] \" [1] /private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02\" #> [137] \" [2] /Library/Frameworks/R.framework/Versions/4.2-arm64/Resources/library\""},{"path":"/reference/FM_fetch_app_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the App State — FM_fetch_app_state","title":"Fetches the App State — FM_fetch_app_state","text":"Returns entire state App","code":""},{"path":"/reference/FM_fetch_app_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the App State — FM_fetch_app_state","text":"","code":"FM_fetch_app_state(session)"},{"path":"/reference/FM_fetch_app_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the App State — FM_fetch_app_state","text":"session Shiny session variable.","code":""},{"path":"/reference/FM_fetch_app_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the App State — FM_fetch_app_state","text":"App state NULL defined.","code":""},{"path":"/reference/FM_fetch_app_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the App State — FM_fetch_app_state","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session app_state = FM_fetch_app_state(session) app_state #> $FM_UD #> $FM_UD$yaml #> $FM_UD$yaml$FM #> $FM_UD$yaml$FM$include #> $FM_UD$yaml$FM$include$files #> $FM_UD$yaml$FM$include$files[[1]] #> $FM_UD$yaml$FM$include$files[[1]]$file #> $FM_UD$yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $FM_UD$yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $FM_UD$yaml$FM$include$files[[2]] #> $FM_UD$yaml$FM$include$files[[2]]$file #> $FM_UD$yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $FM_UD$yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $FM_UD$yaml$FM$include$files[[3]] #> $FM_UD$yaml$FM$include$files[[3]]$file #> $FM_UD$yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $FM_UD$yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $FM_UD$yaml$FM$deployed #> [1] FALSE #> #> $FM_UD$yaml$FM$code #> $FM_UD$yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $FM_UD$yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $FM_UD$yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $FM_UD$yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $FM_UD$yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $FM_UD$yaml$FM$notifications #> $FM_UD$yaml$FM$notifications$config #> $FM_UD$yaml$FM$notifications$config$success #> $FM_UD$yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $FM_UD$yaml$FM$notifications$config$failure #> $FM_UD$yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $FM_UD$yaml$FM$notifications$config$info #> $FM_UD$yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $FM_UD$yaml$FM$notifications$config$warning #> $FM_UD$yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $FM_UD$yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $FM_UD$yaml$FM$reporting #> $FM_UD$yaml$FM$reporting$enabled #> [1] TRUE #> #> $FM_UD$yaml$FM$reporting$content_init #> $FM_UD$yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $FM_UD$yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $FM_UD$yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $FM_UD$yaml$FM$ui #> $FM_UD$yaml$FM$ui$button_style #> [1] \"fill\" #> #> $FM_UD$yaml$FM$ui$select_size #> [1] 10 #> #> $FM_UD$yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $FM_UD$yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $FM_UD$yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $FM_UD$yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $FM_UD$yaml$FM$data_meta #> $FM_UD$yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $FM_UD$yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $FM_UD$yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $FM_UD$yaml$FM$data_meta$data_types #> $FM_UD$yaml$FM$data_meta$data_types$character #> $FM_UD$yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $FM_UD$yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $FM_UD$yaml$FM$data_meta$data_types$double #> $FM_UD$yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $FM_UD$yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $FM_UD$yaml$FM$data_meta$data_types$integer #> $FM_UD$yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $FM_UD$yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $FM_UD$yaml$FM$data_meta$data_types$other #> $FM_UD$yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $FM_UD$yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $FM_UD$yaml$FM$labels #> $FM_UD$yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $FM_UD$yaml$FM$user_files #> $FM_UD$yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $FM_UD$yaml$FM$logging #> $FM_UD$yaml$FM$logging$enabled #> [1] TRUE #> #> $FM_UD$yaml$FM$logging$timestamp #> [1] TRUE #> #> $FM_UD$yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $FM_UD$yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $FM_UD$yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $FM_UD$MC #> $FM_UD$MC$compact #> $FM_UD$MC$compact$code #> [1] FALSE #> #> $FM_UD$MC$compact$preview #> [1] TRUE #> #> #> $FM_UD$MC$reporting #> $FM_UD$MC$reporting$enabled #> [1] FALSE #> #> $FM_UD$MC$reporting$priority #> [1] 1 #> #> #> $FM_UD$MC$labels #> $FM_UD$MC$labels$default_ds #> [1] \"Original data set\" #> #> $FM_UD$MC$labels$upload_button #> [1] \"Select file\" #> #> $FM_UD$MC$labels$tab_main #> [1] \"Upload file\" #> #> $FM_UD$MC$labels$tab_code #> [1] \"Code\" #> #> $FM_UD$MC$labels$tab_preview #> [1] \"Data preview\" #> #> $FM_UD$MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $FM_UD$MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $FM_UD$MC$tooltips #> $FM_UD$MC$tooltips$include #> [1] TRUE #> #> $FM_UD$MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $FM_UD$MC$formatting #> $FM_UD$MC$formatting$preview #> $FM_UD$MC$formatting$preview$width #> [1] 800 #> #> $FM_UD$MC$formatting$preview$height #> [1] 500 #> #> #> $FM_UD$MC$formatting$code #> $FM_UD$MC$formatting$code$width #> [1] 500 #> #> $FM_UD$MC$formatting$code$height #> [1] 200 #> #> #> $FM_UD$MC$formatting$switch_clean #> $FM_UD$MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $FM_UD$MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $FM_UD$MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $FM_UD$MC$code #> $FM_UD$MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $FM_UD$MC$code$readOnly #> [1] TRUE #> #> $FM_UD$MC$code$mode #> [1] \"r\" #> #> $FM_UD$MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $FM_UD$MC$ds_object_name #> [1] \"myDS\" #> #> $FM_UD$MC$clean_data #> $FM_UD$MC$clean_data$enabled #> [1] TRUE #> #> $FM_UD$MC$clean_data$default #> [1] TRUE #> #> $FM_UD$MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $FM_UD$UD #> $FM_UD$UD$isgood #> [1] TRUE #> #> $FM_UD$UD$clean #> [1] TRUE #> #> $FM_UD$UD$load_msg #> <em>File loaded.<\/em> #> #> $FM_UD$UD$data_file_local #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/TEST_DATA.xlsx\" #> #> $FM_UD$UD$data_file_ext #> [1] \"xlsx\" #> #> $FM_UD$UD$data_file #> [1] \"TEST_DATA.xlsx\" #> #> $FM_UD$UD$sheet #> NULL #> #> $FM_UD$UD$sheets #> [1] \"DATA\" \"DDT\" #> #> $FM_UD$UD$code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $FM_UD$UD$object_name #> [1] \"myDS\" #> #> $FM_UD$UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $FM_UD$UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> #> $FM_UD$MOD_TYPE #> [1] \"UD\" #> #> $FM_UD$id #> [1] \"UD\" #> #> $FM_UD$FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $FM_UD$MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml\" #> #>"},{"path":"/reference/FM_fetch_current_mods.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Details About Current Modules — FM_fetch_current_mods","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"Use get information currently supported modules. includes short names, UI elements,","code":""},{"path":"/reference/FM_fetch_current_mods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"","code":"FM_fetch_current_mods()"},{"path":"/reference/FM_fetch_current_mods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"list details currently supported modules.","code":""},{"path":"/reference/FM_fetch_current_mods.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Details About Current Modules — FM_fetch_current_mods","text":"","code":"FM_fetch_current_mods() #> $mods #> $mods$ASM #> $mods$ASM$Name #> [1] \"App State Mangement\" #> #> $mods$ASM$Short_Name #> [1] \"ASM\" #> #> $mods$ASM$UI #> $mods$ASM$UI$htmlOutput #> [1] \"ui_asm_save_name\" \"ui_asm_save_button\" \"ui_asm_load_state\" #> #> $mods$ASM$UI$other #> [1] \"ui_asm_msg\" \"ui_asm_ace_code\" #> #> #> #> $mods$UD #> $mods$UD$Name #> [1] \"Upload Data\" #> #> $mods$UD$Short_Name #> [1] \"UD\" #> #> $mods$UD$UI #> $mods$UD$UI$htmlOutput #> [1] \"ui_ud_load_data\" \"ui_ud_select_sheets\" \"ui_ud_text_load_result\" #> [4] \"ui_ud_data_preview\" #> #> $mods$UD$UI$other #> [1] \"ui_ud_ace_code\" #> #> #> #> $mods$DW #> $mods$DW$Name #> [1] \"Data Wrangling\" #> #> $mods$DW$Short_Name #> [1] \"DW\" #> #> $mods$DW$UI #> $mods$DW$UI$htmlOutput #> [1] \"ui_dw_views\" \"ui_dw_key\" #> [3] \"ui_dw_new_view\" \"ui_dw_save_view\" #> [5] \"ui_dw_del_view\" \"ui_dw_copy_view\" #> [7] \"ui_dw_add_element_button\" \"ui_dw_select\" #> [9] \"ui_dw_new_element_row\" #> #> $mods$DW$UI$other #> [1] \"hot_dw_elements\" \"hot_data_preview\" \"ui_dw_msg\" \"ui_dw_code\" #> #> #> #> $mods$FG #> $mods$FG$Name #> [1] \"Figure Generation\" #> #> $mods$FG$Short_Name #> [1] \"FG\" #> #> $mods$FG$UI #> $mods$FG$UI$htmlOutput #> [1] \"ui_fg_curr_views\" \"ui_fg_curr_figs\" #> [3] \"ui_fg_new_fig\" \"ui_fg_save_fig\" #> [5] \"ui_fg_del_fig\" \"ui_fg_copy_fig\" #> [7] \"ui_fg_fig_name\" \"ui_fg_fig_notes\" #> [9] \"ui_fg_add_element_button\" \"ui_fg_select\" #> [11] \"ui_fg_new_element_row\" \"ui_fg_msg\" #> [13] \"ui_fg_slider_page\" #> #> $mods$FG$UI$other #> [1] \"hot_fg_elements\" \"ui_fg_preview_ggplot\" \"ui_fg_msg\" #> [4] \"ui_fg_code\" #> #> #> #> #> $df #> Module SN #> 1 App State Mangement ASM #> 2 Upload Data UD #> 3 Data Wrangling DW #> 4 Figure Generation FG #> htmlOutput #> 1 ui_asm_save_name, ui_asm_save_button, ui_asm_load_state #> 2 ui_ud_load_data, ui_ud_select_sheets, ui_ud_text_load_result, ui_ud_data_preview #> 3 ui_dw_views, ui_dw_key, ui_dw_new_view, ui_dw_save_view, ui_dw_del_view, ui_dw_copy_view, ui_dw_add_element_button, ui_dw_select, ui_dw_new_element_row #> 4 ui_fg_curr_views, ui_fg_curr_figs, ui_fg_new_fig, ui_fg_save_fig, ui_fg_del_fig, ui_fg_copy_fig, ui_fg_fig_name, ui_fg_fig_notes, ui_fg_add_element_button, ui_fg_select, ui_fg_new_element_row, ui_fg_msg, ui_fg_slider_page #> otherOutput #> 1 ui_asm_msg, ui_asm_ace_code #> 2 ui_ud_ace_code #> 3 hot_dw_elements, hot_data_preview, ui_dw_msg, ui_dw_code #> 4 hot_fg_elements, ui_fg_preview_ggplot, ui_fg_msg, ui_fg_code #>"},{"path":"/reference/FM_fetch_data_format.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates Formatting Information for Datasets — FM_fetch_data_format","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"Takes data frame information site configureation produce formatting information make easier user see data type information.","code":""},{"path":"/reference/FM_fetch_data_format.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"","code":"FM_fetch_data_format(df, state)"},{"path":"/reference/FM_fetch_data_format.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"df Raw dataframe built rhandsontable. state Current module state yaml file read.","code":""},{"path":"/reference/FM_fetch_data_format.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"list following elements: col_heads: List (element column) formatting information column headers use rhandsontable. col_subtext: List (element column) subtext displayed selections using `pickerInput` `shinyWidgets` package.","code":""},{"path":"/reference/FM_fetch_data_format.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Creates Formatting Information for Datasets — FM_fetch_data_format","text":"","code":"# We need a module state object to use this function: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") sheet = \"DATA\" df = readxl::read_excel(path=data_file_local, sheet=sheet) hfmt = FM_fetch_data_format(df, state) # Column header formatting head(as.vector(unlist( hfmt[[\"col_heads\"]]))) #> [1] \"<span style='color:#3C8DBC'><b>ID<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [2] \"<span style='color:#3C8DBC'><b>TIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [3] \"<span style='color:#3C8DBC'><b>TIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [4] \"<span style='color:#3C8DBC'><b>NTIME_DY<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [5] \"<span style='color:#3C8DBC'><b>NTIME_HR<\/b><br/><font size='-3'>num<\/font><\/span>\" #> [6] \"<span style='color:#3C8DBC'><b>TIME<\/b><br/><font size='-3'>num<\/font><\/span>\" # Column select subtext head(as.vector(unlist( hfmt[[\"col_subtext\"]]))) #> [1] \"num: 1,⋅⋅⋅,360\" \"num: 0,⋅⋅⋅,84\" \"num: 0,⋅⋅⋅,2016\" \"num: 0,⋅⋅⋅,42\" #> [5] \"num: 0,⋅⋅⋅,1008\" \"num: 0,⋅⋅⋅,2016\""},{"path":"/reference/FM_fetch_deps.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Dependency Information — FM_fetch_deps","title":"Fetches Dependency Information — FM_fetch_deps","text":"given state session function determine module ids dependent well packages module elements might depend .","code":""},{"path":"/reference/FM_fetch_deps.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Dependency Information — FM_fetch_deps","text":"","code":"FM_fetch_deps(state, session)"},{"path":"/reference/FM_fetch_deps.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Dependency Information — FM_fetch_deps","text":"state Current module state yaml file read session Shiny session variable","code":""},{"path":"/reference/FM_fetch_deps.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Dependency Information — FM_fetch_deps","text":"list following elements: mod_ids Dependent module ids. packages List package dependencies. package_code Library commands load packages.","code":""},{"path":"/reference/FM_fetch_deps.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Dependency Information — FM_fetch_deps","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state mod_deps = FM_fetch_deps(state, session)"},{"path":"/reference/FM_fetch_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Datasets from Modules in the App — FM_fetch_ds","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"Loops specified module ID modules ID specified. ID, attempt made extract datasets available.","code":""},{"path":"/reference/FM_fetch_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"","code":"FM_fetch_ds(state, session, ids = NULL)"},{"path":"/reference/FM_fetch_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"state Current module state yaml file read session Shiny session variable ids Vector ID strings modules containing datasets NULL datasets available.","code":""},{"path":"/reference/FM_fetch_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"list containing current dataset following format: isgood: Boolean indicating whether dataset found (FALSE) ds: List datasets element names corresponding R object name dataset. following format label: Text label dataset (used display user) DS: Data frame dataset DSMETA: Data frame metadata colunns dataset DS. data frame following columns: col1: column 1 code: Code generate dataset. checksum: Module checksum dataset pulled DSchecksum: Checksum dataframe DS catalog: Dataframe containing tabular catalog datasets found. label: Text label object: Name R Object containing data frame MOD_TYPE: Short name type module id: Module ID checksum: Module checksum DSchecksum: Checksum dataset code: Code generate dataset modules: List entry module. element name short name. list entry shiny module ID. checksum. example access checksum DW module module ID 'my_id', use following: res$modules$DW$my_id.","code":""},{"path":"/reference/FM_fetch_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Datasets from Modules in the App — FM_fetch_ds","text":"","code":"# We need a module state and a Shiny session variable # to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state ds = FM_fetch_ds(state, session) ds$catalog #> label object MOD_TYPE id checksum #> 1 Original data set myDS UD UD 897d952fecbc804999396a96f9df4b20 #> DSchecksum #> 1 897d952fecbc804999396a96f9df4b20 #> code #> 1 myDS = readxl::read_excel(path=\"TEST_DATA.xlsx\", sheet=\"DATA\")\\nmyDS = janitor::clean_names(myDS, case=\"none\")"},{"path":"/reference/FM_fetch_log_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Path to the Log File — FM_fetch_log_path","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"Use get path formods log file","code":""},{"path":"/reference/FM_fetch_log_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"","code":"FM_fetch_log_path(state)"},{"path":"/reference/FM_fetch_log_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"state module state yaml read","code":""},{"path":"/reference/FM_fetch_log_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"Character string path log file.","code":""},{"path":"/reference/FM_fetch_log_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Path to the Log File — FM_fetch_log_path","text":"","code":"# Within shiny a session variable will exist, # this creates one here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session # This function assumes that some module state exists: state = UD_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), id = \"UD\", session = session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized FM_fetch_log_path(state) #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/formods_log.txt\""},{"path":"/reference/FM_fetch_mdl.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches Models from Modules in the App — FM_fetch_mdl","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"Loops specified module ID modules ID specified. ID, attempt made extract models available.","code":""},{"path":"/reference/FM_fetch_mdl.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"","code":"FM_fetch_mdl(state, session, ids = NULL)"},{"path":"/reference/FM_fetch_mdl.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"state Current module state yaml file read session Shiny session variable ids Vector ID strings modules containing models NULL modules models available.","code":""},{"path":"/reference/FM_fetch_mdl.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"list containing current dataset following format: JMH isgood: Boolean indicating whether dataset found (FALSE) catalog: Dataframe containing tabular catalog models found. label: Text label modules: List entry module..","code":""},{"path":"/reference/FM_fetch_mdl.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches Models from Modules in the App — FM_fetch_mdl","text":"","code":"# We need a module state and a Shiny session variable # to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state mdl = FM_fetch_mdl(state, session) mdl$catalog #> NULL"},{"path":"/reference/FM_fetch_mod_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch the Module State — FM_fetch_mod_state","title":"Fetch the Module State — FM_fetch_mod_state","text":"Fetches module state userdata specified id","code":""},{"path":"/reference/FM_fetch_mod_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch the Module State — FM_fetch_mod_state","text":"","code":"FM_fetch_mod_state(session, id)"},{"path":"/reference/FM_fetch_mod_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch the Module State — FM_fetch_mod_state","text":"session Shiny session variable. id ID string module.","code":""},{"path":"/reference/FM_fetch_mod_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch the Module State — FM_fetch_mod_state","text":"module state NULL defined.","code":""},{"path":"/reference/FM_fetch_mod_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch the Module State — FM_fetch_mod_state","text":"","code":"# We need a Shiny session variable to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = FM_fetch_mod_state(session, id)"},{"path":"/reference/FM_fetch_user_files_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Path to the User Files — FM_fetch_user_files_path","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"Use get path temporary directory formods stores user files.","code":""},{"path":"/reference/FM_fetch_user_files_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"","code":"FM_fetch_user_files_path(state)"},{"path":"/reference/FM_fetch_user_files_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"state module state yaml read","code":""},{"path":"/reference/FM_fetch_user_files_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"Character string path log file.","code":""},{"path":"/reference/FM_fetch_user_files_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Path to the User Files — FM_fetch_user_files_path","text":"","code":"# We need a state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state user_dir = FM_fetch_user_files_path(state) user_dir #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM\""},{"path":"/reference/FM_generate_report.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate Report — FM_generate_report","title":"Generate Report — FM_generate_report","text":"Generates report states different modules. type report based file extension file_name.","code":""},{"path":"/reference/FM_generate_report.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate Report — FM_generate_report","text":"","code":"FM_generate_report( state, session, file_dir, file_name, gen_code_only = FALSE, rpterrors = TRUE )"},{"path":"/reference/FM_generate_report.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate Report — FM_generate_report","text":"state Module state requesting report generation session Shiny session variable file_dir path location file written. file_name base_filename (acceptable extensions xlsx, docx, pptx). gen_code_only Boolean value indicating code generated (FALSE). rpterrors Boolean variable generate reports errors.","code":""},{"path":"/reference/FM_generate_report.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate Report — FM_generate_report","text":"List following elements","code":""},{"path":"/reference/FM_generate_report.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Generate Report — FM_generate_report","text":"function look loaded modules find reporting enabbled. reporting enabled look reporting functions module. Reporting functions following format (name arguments): XX_append_report(state, rpt, rpttype) XX module short name. state current state module. rpt contains current content report. vary based report type: xlsx: List two elements. first summary data frame two columns. first column called Sheet_Name second column called Description. catalog sheets added report user can appended using rbind. second element xlsx rpt another list element names corresponding report sheet names values corresponding dataframes exported report. pptx docx: Corresponding onbrand reporting object.","code":""},{"path":"/reference/FM_generate_report.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate Report — FM_generate_report","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 session = sess_res$session input = sess_res$input # This will create a populated FG state object: state = sess_res$state # This is the directory to write the report: file_dir = tempdir() # This is the file name that determines the type of report to write: file_name = \"my_report.pptx\" rpt_res = FM_generate_report(state = state, session = session, file_dir = file_dir, file_name = file_name, gen_code_only = TRUE, rpterrors = TRUE) #> → FG: Generating report: pptx #> → FG: appending report for module:DW id:DW priority:1 #> → FG: appending report for module:FG id:FG priority:1 # This contains the exit status of the report generation rpt_res$isgood #> [1] TRUE # This is the underlying code that was used to generate the report cat(paste0(rpt_res$code, collapse=\"\\n\")) #> rpt = onbrand::read_template( #> template = file.path(\"config\", \"report.pptx\"), #> mapping = file.path(\"config\", \"report.yaml\")) #> # Figure Fig_1(1): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=1)), #> type = \"ggplot\"))) #> # Figure Fig_1(2): Individual profiles by cohort #> rpt = onbrand::report_add_slide(rpt, #> template = \"content_list\", #> elements = list( #> title = list( content = \"Individual profiles by cohort\", #> type = \"text\"), #> content_body = list( content = ( FG_myp_1 + ggforce::facet_wrap_paginate(vars(Cohort), nrow = 3, ncol = 4, page=2)), #> type = \"ggplot\"))) #> onbrand::save_report(rpt, file.path(\"reports\", \"report.pptx\"))"},{"path":"/reference/FM_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize a formods State Object — FM_init_state","title":"Initialize a formods State Object — FM_init_state","text":"Initializes formods state object common elements.","code":""},{"path":"/reference/FM_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize a formods State Object — FM_init_state","text":"","code":"FM_init_state( FM_yaml_file, MOD_yaml_file, id, dep_mod_ids = c(), MT, button_counters, ui_ids, ui_hold, session )"},{"path":"/reference/FM_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize a formods State Object — FM_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id Shiny module ID. dep_mod_ids Vector module ids module depends . MT Type module using short name (e.g. \"UD\", \"FG\", etc.). button_counters Vector button UI elements need tracked. ui_ids List UI ids module. ui_hold Vector UI elements require holding. session Shiny session variable","code":""},{"path":"/reference/FM_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize a formods State Object — FM_init_state","text":"List state initialized.","code":""},{"path":"/reference/FM_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize a formods State Object — FM_init_state","text":"","code":"# Within shiny a session variable will exist, # this creates examples here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = FM_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), id = \"UD\", MT = \"UD\", button_counters = NULL, ui_ids = NULL, ui_hold = NULL, session = session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] FALSE #> #> $MC$compact$preview #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$labels #> $MC$labels$default_ds #> [1] \"Original data set\" #> #> $MC$labels$upload_button #> [1] \"Select file\" #> #> $MC$labels$tab_main #> [1] \"Upload file\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$tab_preview #> [1] \"Data preview\" #> #> $MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 500 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 500 #> #> $MC$formatting$code$height #> [1] 200 #> #> #> $MC$formatting$switch_clean #> $MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $MC$code #> $MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"myDS\" #> #> $MC$clean_data #> $MC$clean_data$enabled #> [1] TRUE #> #> $MC$clean_data$default #> [1] TRUE #> #> $MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $UD #> $UD$button_counters #> list() #> #> $UD$ui_hold #> list() #> #> $UD$isgood #> [1] TRUE #> #> #> $MOD_TYPE #> [1] \"UD\" #> #> $id #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml\" #>"},{"path":"/reference/FM_le.html","id":null,"dir":"Reference","previous_headings":"","what":"Adds Message to Log File and Displays it to the Console — FM_le","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"Add supplied txt module type log file display console.","code":""},{"path":"/reference/FM_le.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"","code":"FM_le(state, entry, escape_braces = TRUE, entry_type = \"alert\")"},{"path":"/reference/FM_le.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"state Module state yaml read entry Text add escape_braces Set TRUE (default) escape curly braces entry, set FALSE values interpreted. entry_type Set either \"alert\"(default), \"danger\", \"info\", \"success\", \"warning\"","code":""},{"path":"/reference/FM_le.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"Boolean value indicating success (TRUE) failure (FALSE).","code":""},{"path":"/reference/FM_le.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Adds Message to Log File and Displays it to the Console — FM_le","text":"","code":"# We need a module state to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state FM_le(state, \"This is a normal message\") #> → UD: This is a normal message #> NULL FM_le(state, \"This is a danger message\", entry_type=\"danger\") #> ✖ UD: This is a danger message #> NULL FM_le(state, \"This is a info message\", entry_type=\"info\") #> ℹ UD: This is a info message #> NULL FM_le(state, \"This is a success message\", entry_type=\"success\") #> ✔ UD: This is a success message #> NULL FM_le(state, \"This is a warning message\", entry_type=\"warning\") #> ! UD: This is a warning message #> NULL"},{"path":"/reference/FM_message.html","id":null,"dir":"Reference","previous_headings":"","what":"Show Message to User — FM_message","title":"Show Message to User — FM_message","text":"Writes message console depending whether cli installed .","code":""},{"path":"/reference/FM_message.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Show Message to User — FM_message","text":"","code":"FM_message(line, escape_braces = TRUE, entry_type = \"alert\")"},{"path":"/reference/FM_message.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Show Message to User — FM_message","text":"line Text display escape_braces Set TRUE (default) escape curly braces entry, set FALSE values interpreted. entry_type Set either \"alert\"(default), \"danger\", \"info\", \"success\", \"warning\"","code":""},{"path":"/reference/FM_message.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Show Message to User — FM_message","text":"Returns NULL","code":""},{"path":"/reference/FM_message.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Show Message to User — FM_message","text":"","code":"FM_message(\"This is a normal message\") #> → This is a normal message #> NULL FM_message(\"This is a danger message\", entry_type=\"danger\") #> ✖ This is a danger message #> NULL FM_message(\"This is a info message\", entry_type=\"info\") #> ℹ This is a info message #> NULL FM_message(\"This is a success message\", entry_type=\"success\") #> ✔ This is a success message #> NULL FM_message(\"This is a warning message\", entry_type=\"warning\") #> ! This is a warning message #> NULL"},{"path":"/reference/FM_mk_error_fig.html","id":null,"dir":"Reference","previous_headings":"","what":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"Takes vector messages returns ggplot object text figure. can used automated figure generation cascade error message end user.","code":""},{"path":"/reference/FM_mk_error_fig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"","code":"FM_mk_error_fig(msgs)"},{"path":"/reference/FM_mk_error_fig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"msgs Vector error messages","code":""},{"path":"/reference/FM_mk_error_fig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"ggplot object","code":""},{"path":"/reference/FM_mk_error_fig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generates `ggplot` Object with Error Message — FM_mk_error_fig","text":"","code":"FM_mk_error_fig(\"Oh nos! You've made a mistake!\")"},{"path":"/reference/FM_notify.html","id":null,"dir":"Reference","previous_headings":"","what":"Shiny Notification — FM_notify","title":"Shiny Notification — FM_notify","text":"Generates notification show .","code":""},{"path":"/reference/FM_notify.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shiny Notification — FM_notify","text":"","code":"FM_notify(state, session)"},{"path":"/reference/FM_notify.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shiny Notification — FM_notify","text":"state Module state generating notification session Shiny session variable","code":""},{"path":"/reference/FM_notify.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shiny Notification — FM_notify","text":"Boolean variable indicating notification triggered","code":""},{"path":"/reference/FM_notify.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Shiny Notification — FM_notify","text":"","code":"if(interactive()){ library(formods) library(shiny) library(shinydashboard) #https://fontawesome.com/icons?from=io ui <- dashboardPage( skin=\"red\", dashboardHeader(title=\"Test Notifications\"), dashboardSidebar( sidebarMenu( menuItem(\"Notifications\", tabName=\"example\", icon=icon(\"table\")) ) ), dashboardBody( tabItems( tabItem(tabName=\"example\", fluidRow( shiny::actionButton(\"set_notification\", \"Set Notification\"), shiny::textInput(\"user_text\", label=\"Notify Text Here\", value=\"Notify me\"), shiny::actionButton(\"show_notification\", \"Show Notification\") ) ) ) ) ) # Main app server server <- function(input, output, session) { # Need formods state object sess_res = UD_test_mksession(session, id=\"UD\") # Captures input and sets the notification observeEvent(input$set_notification, { state = FM_fetch_mod_state(session, id=\"UD\") state = FM_set_notification(state, notify_text = isolate(input$user_text), notify_id = \"example\") FM_set_mod_state(session, id=\"UD\", state) }) # Displays the notification observeEvent(input$show_notification, { state = FM_fetch_mod_state(session, id=\"UD\") FM_notify(state, session) }) } shinyApp(ui, server) }"},{"path":"/reference/FM_pause_screen.html","id":null,"dir":"Reference","previous_headings":"","what":"Starts Modal Screen Pause — FM_pause_screen","title":"Starts Modal Screen Pause — FM_pause_screen","text":"Start modal screen pause.","code":""},{"path":"/reference/FM_pause_screen.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Starts Modal Screen Pause — FM_pause_screen","text":"","code":"FM_pause_screen(state, session, message)"},{"path":"/reference/FM_pause_screen.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Starts Modal Screen Pause — FM_pause_screen","text":"state Current module state yaml file read. session Shiny session variable. message Optional message pause.","code":""},{"path":"/reference/FM_pause_screen.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Starts Modal Screen Pause — FM_pause_screen","text":"Pauses screen return value.","code":""},{"path":"/reference/FM_pause_screen.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Starts Modal Screen Pause — FM_pause_screen","text":"","code":"# We need a module state object and Shiny session objects to use this function: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state FM_pause_screen(state, session) #> NULL FM_resume_screen(state, session) #> NULL"},{"path":"/reference/FM_pretty_sort.html","id":null,"dir":"Reference","previous_headings":"","what":"Centralized Sorting Function — FM_pretty_sort","title":"Centralized Sorting Function — FM_pretty_sort","text":"displaying information pull function can used sort options.","code":""},{"path":"/reference/FM_pretty_sort.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Centralized Sorting Function — FM_pretty_sort","text":"","code":"FM_pretty_sort(unsrt_data)"},{"path":"/reference/FM_pretty_sort.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Centralized Sorting Function — FM_pretty_sort","text":"unsrt_data Unsorted data.","code":""},{"path":"/reference/FM_pretty_sort.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Centralized Sorting Function — FM_pretty_sort","text":"sorted data","code":""},{"path":"/reference/FM_pretty_sort.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Centralized Sorting Function — FM_pretty_sort","text":"","code":"# This is the full path to a test data file: data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") # Excel files need a sheet specification: sheet = \"DATA\" # We will also attach the sheets along with it df = readxl::read_excel(path=data_file_local, sheet=sheet) # Regular sorting: sort(unique(df$Cohort)) #> [1] \"MD 10 mg IV\" \"MD 10 mg SC\" \"MD 100 mg IV\" \"MD 100 mg SC\" \"MD 3 mg IV\" #> [6] \"MD 3 mg SC\" \"MD 30 mg IV\" \"MD 30 mg SC\" \"MD 300 mg IV\" \"MD 300 mg SC\" #> [11] \"MD 500 mg IV\" \"MD 500 mg SC\" \"SD 10 mg IV\" \"SD 100 mg IV\" \"SD 3 mg IV\" #> [16] \"SD 30 mg IV\" \"SD 300 mg IV\" \"SD 500 mg IV\" FM_pretty_sort(unique(df$Cohort)) #> [1] \"MD 3 mg IV\" \"MD 3 mg SC\" \"MD 10 mg IV\" \"MD 10 mg SC\" \"MD 30 mg IV\" #> [6] \"MD 30 mg SC\" \"MD 100 mg IV\" \"MD 100 mg SC\" \"MD 300 mg IV\" \"MD 300 mg SC\" #> [11] \"MD 500 mg IV\" \"MD 500 mg SC\" \"SD 3 mg IV\" \"SD 10 mg IV\" \"SD 30 mg IV\" #> [16] \"SD 100 mg IV\" \"SD 300 mg IV\" \"SD 500 mg IV\""},{"path":"/reference/FM_proc_include.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Message in State from UI Processing — FM_proc_include","title":"Sets Message in State from UI Processing — FM_proc_include","text":"errors need passed back user can set function.","code":""},{"path":"/reference/FM_proc_include.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Message in State from UI Processing — FM_proc_include","text":"","code":"FM_proc_include(state, session)"},{"path":"/reference/FM_proc_include.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Message in State from UI Processing — FM_proc_include","text":"state formods State object. session Shiny session variable.","code":""},{"path":"/reference/FM_proc_include.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Message in State from UI Processing — FM_proc_include","text":"return value, sets message supplied session variable.","code":""},{"path":"/reference/FM_proc_include.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Message in State from UI Processing — FM_proc_include","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state session = sess_res$session FM_proc_include(state, session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\")"},{"path":"/reference/FM_resume_screen.html","id":null,"dir":"Reference","previous_headings":"","what":"Stops Modal Screen Pause — FM_resume_screen","title":"Stops Modal Screen Pause — FM_resume_screen","text":"Stops Modal Screen Pause","code":""},{"path":"/reference/FM_resume_screen.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stops Modal Screen Pause — FM_resume_screen","text":"","code":"FM_resume_screen(state, session)"},{"path":"/reference/FM_resume_screen.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stops Modal Screen Pause — FM_resume_screen","text":"state Current module state yaml file read. session Shiny session variable.","code":""},{"path":"/reference/FM_resume_screen.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stops Modal Screen Pause — FM_resume_screen","text":"return value, called disable screen pause.","code":""},{"path":"/reference/FM_resume_screen.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Stops Modal Screen Pause — FM_resume_screen","text":"","code":"# We need a module state object and Shiny session objects to use this function: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state FM_pause_screen(state, session) #> NULL FM_resume_screen(state, session) #> NULL"},{"path":"/reference/FM_set_app_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the App State — FM_set_app_state","title":"Set the App State — FM_set_app_state","text":"Takes loaded app state overwrites current app state","code":""},{"path":"/reference/FM_set_app_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the App State — FM_set_app_state","text":"","code":"FM_set_app_state(session, app_state, set_holds = TRUE)"},{"path":"/reference/FM_set_app_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the App State — FM_set_app_state","text":"session Shiny session variable. app_state Loaded app state. set_holds TRUE (default) holds set modules present app state.","code":""},{"path":"/reference/FM_set_app_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the App State — FM_set_app_state","text":"return value, just updates app state session variable.","code":""},{"path":"/reference/FM_set_app_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the App State — FM_set_app_state","text":"","code":"# We need a Shiny session object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session app_state = FM_fetch_app_state(session) FM_set_app_state(session, app_state) #> → FM_set_app_state() #> → Unable to find ASM state. #> NULL"},{"path":"/reference/FM_set_mod_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the Module State — FM_set_mod_state","title":"Set the Module State — FM_set_mod_state","text":"Sets module state userdata specified id","code":""},{"path":"/reference/FM_set_mod_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the Module State — FM_set_mod_state","text":"","code":"FM_set_mod_state(session, id, state)"},{"path":"/reference/FM_set_mod_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the Module State — FM_set_mod_state","text":"session Shiny session variable id ID string module. state Module state set.","code":""},{"path":"/reference/FM_set_mod_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the Module State — FM_set_mod_state","text":"Session variable module state set.","code":""},{"path":"/reference/FM_set_mod_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the Module State — FM_set_mod_state","text":"","code":"# We need a Shiny session variable and a module state # object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = sess_res$state FM_set_mod_state(session, id, state) #> $userData #> $userData$FM #> $userData$FM$FM_UD #> $userData$FM$FM_UD$yaml #> $userData$FM$FM_UD$yaml$FM #> $userData$FM$FM_UD$yaml$FM$include #> $userData$FM$FM_UD$yaml$FM$include$files #> $userData$FM$FM_UD$yaml$FM$include$files[[1]] #> $userData$FM$FM_UD$yaml$FM$include$files[[1]]$file #> $userData$FM$FM_UD$yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $userData$FM$FM_UD$yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $userData$FM$FM_UD$yaml$FM$include$files[[2]] #> $userData$FM$FM_UD$yaml$FM$include$files[[2]]$file #> $userData$FM$FM_UD$yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $userData$FM$FM_UD$yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $userData$FM$FM_UD$yaml$FM$include$files[[3]] #> $userData$FM$FM_UD$yaml$FM$include$files[[3]]$file #> $userData$FM$FM_UD$yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $userData$FM$FM_UD$yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $userData$FM$FM_UD$yaml$FM$deployed #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$code #> $userData$FM$FM_UD$yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $userData$FM$FM_UD$yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $userData$FM$FM_UD$yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $userData$FM$FM_UD$yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications #> $userData$FM$FM_UD$yaml$FM$notifications$config #> $userData$FM$FM_UD$yaml$FM$notifications$config$success #> $userData$FM$FM_UD$yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$info #> $userData$FM$FM_UD$yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $userData$FM$FM_UD$yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $userData$FM$FM_UD$yaml$FM$reporting #> $userData$FM$FM_UD$yaml$FM$reporting$enabled #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$reporting$content_init #> $userData$FM$FM_UD$yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $userData$FM$FM_UD$yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $userData$FM$FM_UD$yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $userData$FM$FM_UD$yaml$FM$ui #> $userData$FM$FM_UD$yaml$FM$ui$button_style #> [1] \"fill\" #> #> $userData$FM$FM_UD$yaml$FM$ui$select_size #> [1] 10 #> #> $userData$FM$FM_UD$yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $userData$FM$FM_UD$yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $userData$FM$FM_UD$yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $userData$FM$FM_UD$yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta #> $userData$FM$FM_UD$yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$character #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$double #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$integer #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$other #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $userData$FM$FM_UD$yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $userData$FM$FM_UD$yaml$FM$labels #> $userData$FM$FM_UD$yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $userData$FM$FM_UD$yaml$FM$user_files #> $userData$FM$FM_UD$yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $userData$FM$FM_UD$yaml$FM$logging #> $userData$FM$FM_UD$yaml$FM$logging$enabled #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$logging$timestamp #> [1] TRUE #> #> $userData$FM$FM_UD$yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $userData$FM$FM_UD$yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $userData$FM$FM_UD$yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $userData$FM$FM_UD$MC #> $userData$FM$FM_UD$MC$compact #> $userData$FM$FM_UD$MC$compact$code #> [1] FALSE #> #> $userData$FM$FM_UD$MC$compact$preview #> [1] TRUE #> #> #> $userData$FM$FM_UD$MC$reporting #> $userData$FM$FM_UD$MC$reporting$enabled #> [1] FALSE #> #> $userData$FM$FM_UD$MC$reporting$priority #> [1] 1 #> #> #> $userData$FM$FM_UD$MC$labels #> $userData$FM$FM_UD$MC$labels$default_ds #> [1] \"Original data set\" #> #> $userData$FM$FM_UD$MC$labels$upload_button #> [1] \"Select file\" #> #> $userData$FM$FM_UD$MC$labels$tab_main #> [1] \"Upload file\" #> #> $userData$FM$FM_UD$MC$labels$tab_code #> [1] \"Code\" #> #> $userData$FM$FM_UD$MC$labels$tab_preview #> [1] \"Data preview\" #> #> $userData$FM$FM_UD$MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $userData$FM$FM_UD$MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $userData$FM$FM_UD$MC$tooltips #> $userData$FM$FM_UD$MC$tooltips$include #> [1] TRUE #> #> $userData$FM$FM_UD$MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $userData$FM$FM_UD$MC$formatting #> $userData$FM$FM_UD$MC$formatting$preview #> $userData$FM$FM_UD$MC$formatting$preview$width #> [1] 800 #> #> $userData$FM$FM_UD$MC$formatting$preview$height #> [1] 500 #> #> #> $userData$FM$FM_UD$MC$formatting$code #> $userData$FM$FM_UD$MC$formatting$code$width #> [1] 500 #> #> $userData$FM$FM_UD$MC$formatting$code$height #> [1] 200 #> #> #> $userData$FM$FM_UD$MC$formatting$switch_clean #> $userData$FM$FM_UD$MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $userData$FM$FM_UD$MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $userData$FM$FM_UD$MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $userData$FM$FM_UD$MC$code #> $userData$FM$FM_UD$MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $userData$FM$FM_UD$MC$code$readOnly #> [1] TRUE #> #> $userData$FM$FM_UD$MC$code$mode #> [1] \"r\" #> #> $userData$FM$FM_UD$MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $userData$FM$FM_UD$MC$ds_object_name #> [1] \"myDS\" #> #> $userData$FM$FM_UD$MC$clean_data #> $userData$FM$FM_UD$MC$clean_data$enabled #> [1] TRUE #> #> $userData$FM$FM_UD$MC$clean_data$default #> [1] TRUE #> #> $userData$FM$FM_UD$MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $userData$FM$FM_UD$UD #> $userData$FM$FM_UD$UD$isgood #> [1] TRUE #> #> $userData$FM$FM_UD$UD$clean #> [1] TRUE #> #> $userData$FM$FM_UD$UD$load_msg #> <em>File loaded.<\/em> #> #> $userData$FM$FM_UD$UD$data_file_local #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/FM/TEST_DATA.xlsx\" #> #> $userData$FM$FM_UD$UD$data_file_ext #> [1] \"xlsx\" #> #> $userData$FM$FM_UD$UD$data_file #> [1] \"TEST_DATA.xlsx\" #> #> $userData$FM$FM_UD$UD$sheet #> NULL #> #> $userData$FM$FM_UD$UD$sheets #> [1] \"DATA\" \"DDT\" #> #> $userData$FM$FM_UD$UD$code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $userData$FM$FM_UD$UD$object_name #> [1] \"myDS\" #> #> $userData$FM$FM_UD$UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $userData$FM$FM_UD$UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> #> $userData$FM$FM_UD$MOD_TYPE #> [1] \"UD\" #> #> $userData$FM$FM_UD$id #> [1] \"UD\" #> #> $userData$FM$FM_UD$FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $userData$FM$FM_UD$MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml\" #> #> #> #>"},{"path":"/reference/FM_set_notification.html","id":null,"dir":"Reference","previous_headings":"","what":"Shiny Notification — FM_set_notification","title":"Shiny Notification — FM_set_notification","text":"Generates notification show .","code":""},{"path":"/reference/FM_set_notification.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Shiny Notification — FM_set_notification","text":"","code":"FM_set_notification(state, notify_text, notify_id, type = \"info\")"},{"path":"/reference/FM_set_notification.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Shiny Notification — FM_set_notification","text":"state Module state generating notification notify_text Text go notification notify_id Unique string notification type - Can either \"success\", \"failure\", \"info\" (default), \"warning\"","code":""},{"path":"/reference/FM_set_notification.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Shiny Notification — FM_set_notification","text":"Module state notification text set","code":""},{"path":"/reference/FM_set_notification.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Shiny Notification — FM_set_notification","text":"","code":"if(interactive()){ library(formods) library(shiny) library(shinydashboard) #https://fontawesome.com/icons?from=io ui <- dashboardPage( skin=\"red\", dashboardHeader(title=\"Test Notifications\"), dashboardSidebar( sidebarMenu( menuItem(\"Notifications\", tabName=\"example\", icon=icon(\"table\")) ) ), dashboardBody( tabItems( tabItem(tabName=\"example\", fluidRow( shiny::actionButton(\"set_notification\", \"Set Notification\"), shiny::textInput(\"user_text\", label=\"Notify Text Here\", value=\"Notify me\"), shiny::actionButton(\"show_notification\", \"Show Notification\") ) ) ) ) ) # Main app server server <- function(input, output, session) { # Need formods state object sess_res = UD_test_mksession(session, id=\"UD\") # Captures input and sets the notification observeEvent(input$set_notification, { state = FM_fetch_mod_state(session, id=\"UD\") state = FM_set_notification(state, notify_text = isolate(input$user_text), notify_id = \"example\") FM_set_mod_state(session, id=\"UD\", state) }) # Displays the notification observeEvent(input$show_notification, { state = FM_fetch_mod_state(session, id=\"UD\") FM_notify(state, session) }) } shinyApp(ui, server) }"},{"path":"/reference/FM_set_ui_msg.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Message in State from UI Processing — FM_set_ui_msg","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"errors need passed back user can set function.","code":""},{"path":"/reference/FM_set_ui_msg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"","code":"FM_set_ui_msg(state, msgs, append = FALSE)"},{"path":"/reference/FM_set_ui_msg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"state formods State object. msgs Character vector messages. append TRUE, msgs appended current messages. FALSE (default) msgs replace existing messaages.","code":""},{"path":"/reference/FM_set_ui_msg.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"state ui message set.","code":""},{"path":"/reference/FM_set_ui_msg.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Message in State from UI Processing — FM_set_ui_msg","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list(), id=id) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state state = FM_set_ui_msg(state, \"Something happend.\")"},{"path":"/reference/FM_tc.html","id":null,"dir":"Reference","previous_headings":"","what":"Run Try/Catch and Process Results — FM_tc","title":"Run Try/Catch and Process Results — FM_tc","text":"Attempts execute text cmd. done try/catch environment capture errors.","code":""},{"path":"/reference/FM_tc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run Try/Catch and Process Results — FM_tc","text":"","code":"FM_tc(cmd, tc_env, capture)"},{"path":"/reference/FM_tc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run Try/Catch and Process Results — FM_tc","text":"cmd Character object containing R command evaluate try/catch block tc_env list names corresponding object names corresponding Values define try/catch environment capture Character vector values capture command successfully captured","code":""},{"path":"/reference/FM_tc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Run Try/Catch and Process Results — FM_tc","text":"list following fields: isgood: Boolean indicating whether evaluation successful. error: evaluation failed contains error object. msgs: Character vector messages /errors. capture: List names objects captured values corresponding captured objects.","code":""},{"path":"/reference/FM_tc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Run Try/Catch and Process Results — FM_tc","text":"","code":"# Successful command res_good = FM_tc(\"good_cmd=ls()\", list(), c(\"good_cmd\")) res_good #> $capture #> $capture$good_cmd #> [1] \"capture\" \"cmd\" \"isgood\" \"msgs\" \"name\" \"tc_env\" \"tcres\" #> #> #> $isgood #> [1] TRUE #> # Failed command res_bad = FM_tc(\"bad_cmd =not_a_command()\", list(), c(\"bad_cmd\")) res_bad #> $error #> <simpleError in not_a_command(): could not find function \"not_a_command\"> #> #> $isgood #> [1] FALSE #> #> $msgs #> [1] \"message: could not find function \\\"not_a_command\\\"\" #> [2] \"call: not_a_command\" #>"},{"path":"/reference/UD_Server.html","id":null,"dir":"Reference","previous_headings":"","what":"Data Upload Server — UD_Server","title":"Data Upload Server — UD_Server","text":"Server function Data Uplaod Shiny Module","code":""},{"path":"/reference/UD_Server.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Data Upload Server — UD_Server","text":"","code":"UD_Server( id, id_ASM = \"ASM\", FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), deployed = FALSE, react_state = NULL )"},{"path":"/reference/UD_Server.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Data Upload Server — UD_Server","text":"id ID string corresponds ID used call modules UI elements id_ASM ID string app state management module used save load app states FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. deployed Boolean variable indicating whether app deployed . react_state Variable passed server allow reaction outside module (NULL)","code":""},{"path":"/reference/UD_Server.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Data Upload Server — UD_Server","text":"UD Server object","code":""},{"path":"/reference/UD_Server.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Data Upload Server — UD_Server","text":"","code":"if(interactive()){ # These are suggested packages library(shinydashboard) library(ggpubr) library(plotly) library(shinybusy) library(prompter) library(utils) library(clipr) library(formods) CSS <- \" .wrapfig { float: right; shape-margin: 20px; margin-right: 20px; margin-bottom: 20px; } \" # Default to not deployed if(!exists(\"deployed\")){ deployed = FALSE } #https://fontawesome.com/icons?from=io data_url = \"https://github.com/john-harrold/formods/raw/master/inst/test_data/TEST_DATA.xlsx\" ui <- dashboardPage( skin=\"black\", dashboardHeader(title=\"formods\"), dashboardSidebar( sidebarMenu( menuItem(\"Source Data\", tabName=\"upload\", icon=icon(\"table\")) , menuItem(\"Wrangle\", tabName=\"wrangle\", icon=icon(\"hat-cowboy\")), menuItem(\"Plot\", tabName=\"plot\", icon=icon(\"chart-line\")), menuItem(\"App State\", tabName=\"app_state\", icon=icon(\"archive\")), menuItem(\"App Info\", tabName=\"sysinfo\", icon=icon(\"book-medical\")) ) ), dashboardBody( tags$head( tags$style(HTML(CSS)) ), tabItems( tabItem(tabName=\"app_state\", box(title=\"Manage App State\", htmlOutput(NS(\"ASM\", \"ui_asm_compact\")))), tabItem(tabName=\"upload\", box(title=\"Load Data\", width=12, fluidRow( prompter::use_prompt(), column(width=6, htmlOutput(NS(\"UD\", \"UD_ui_compact\"))), column(width=6, tags$p( tags$img( class = \"wrapfig\", src = \"https://github.com/john-harrold/formods/raw/master/man/figures/logo.png\", width = 100, alt = \"formods logo\" ), 'Formods is a set of modules and an framework for developing modules which interact and create code to replicate analyses performed within an app. To experiment download this', tags$a(\"test dataset\", href=data_url), 'and upload it into the App using the form on the left.')) ) ) ), tabItem(tabName=\"wrangle\", box(title=\"Transform and Create Views of Your Data\", width=12, htmlOutput(NS(\"DW\", \"DW_ui_compact\")))), tabItem(tabName=\"plot\", box(title=\"Visualize Data\", width=12, htmlOutput(NS(\"FG\", \"FG_ui_compact\")))), tabItem(tabName=\"sysinfo\", box(title=\"System Details\", width=12, shinydashboard::tabBox( width = 12, title = NULL, shiny::tabPanel(id=\"sys_modules\", title=tagList(shiny::icon(\"ghost\"), \"Modules\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_modules\")) ), shiny::tabPanel(id=\"sys_packages\", title=tagList(shiny::icon(\"ghost\"), \"Packages\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_packages\")) ), shiny::tabPanel(id=\"sys_log\", title=tagList(shiny::icon(\"clipboard-list\"), \"App Log\"), verbatimTextOutput(NS(\"ASM\", \"ui_asm_sys_log\")) ), shiny::tabPanel(id=\"sys_options\", title=tagList(shiny::icon(\"sliders\"), \"R Options\"), htmlOutput(NS(\"ASM\", \"ui_asm_sys_options\")) ) ) )) ) ) ) # Main app server server <- function(input, output, session) { # Empty reactive object to track and react to # changes in the module state outside of the module react_FM = reactiveValues() # This is the list of module ids used for reproducible script generation. The # order here is important. mod_ids = c(\"UD\", \"DW\", \"FG\") #Populating with test data FG_test_mksession(session) # Module servers formods::ASM_Server(id=\"ASM\", deployed = deployed, react_state = react_FM, mod_ids = mod_ids) formods::UD_Server( id=\"UD\", id_ASM = \"ASM\", deployed = deployed, react_state = react_FM) formods::DW_Server( id=\"DW\", id_ASM = \"ASM\",id_UD = \"UD\", deployed = deployed, react_state = react_FM) formods::FG_Server( id=\"FG\", id_ASM = \"ASM\",id_UD = \"UD\", id_DW = \"DW\", deployed = deployed, react_state = react_FM) } shinyApp(ui, server) }"},{"path":"/reference/UD_attach_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Attach Data Set to UD State — UD_attach_ds","title":"Attach Data Set to UD State — UD_attach_ds","text":"Attaches dataset UD state supplied.","code":""},{"path":"/reference/UD_attach_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Attach Data Set to UD State — UD_attach_ds","text":"","code":"UD_attach_ds( state, clean = NULL, isgood = TRUE, load_msg = NULL, data_file_local = NULL, data_file_ext = NULL, data_file = NULL, sheet = NULL, sheets = NULL, code = \"\", object_name = NULL, contents = NULL )"},{"path":"/reference/UD_attach_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Attach Data Set to UD State — UD_attach_ds","text":"state UD state module. clean Boolean switch determine headers loaded dataset cleaned. isgood Boolean object indicating file successfully loaded. load_msg Text message indicated success problems encountered uploading file. data_file_local Full path data file server. data_file_ext File extension uploaded file. data_file Dataset file name without path. sheet uploaded file excel file, currently selected sheet. sheets uploaded file excel file, character vector sheets present file. code Code load dataset. object_name Name dataset object created code evaluated. contents Data frame containting contents data file.","code":""},{"path":"/reference/UD_attach_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Attach Data Set to UD State — UD_attach_ds","text":"state data set attached","code":""},{"path":"/reference/UD_attach_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Attach Data Set to UD State — UD_attach_ds","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state # This is the full path to a test data file: data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") # Excel file extension data_file_ext = \"xlsx\" # Base file name data_file = \"TEST_DATA.xlsx\" # Excel files need a sheet specification: sheet = \"DATA\" # We will also attach the sheets along with it sheets = readxl::excel_sheets(data_file_local) ds_read_res = UD_ds_read(state, data_file_ext = data_file_ext, data_file_local = data_file_local, data_file = data_file, sheets = sheets, sheet = sheet) # This would contain the loading code that will cascade down # to the other modules when generating snippets and # reproducible scripts code = ds_read_res$code # This is the R Object name that is used internally # and in generated scripts. Should be the same as in # the code above object_name = ds_read_res$object_name # This is the actual dataset: contents = ds_read_res$contents state = UD_attach_ds( state, data_file_local = data_file_local, data_file_ext = \".xlsx\", data_file = data_file, sheet = sheet, sheets = sheets, code = code, object_name = object_name, contents = contents) state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] FALSE #> #> $MC$compact$preview #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$labels #> $MC$labels$default_ds #> [1] \"Original data set\" #> #> $MC$labels$upload_button #> [1] \"Select file\" #> #> $MC$labels$tab_main #> [1] \"Upload file\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$tab_preview #> [1] \"Data preview\" #> #> $MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 500 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 500 #> #> $MC$formatting$code$height #> [1] 200 #> #> #> $MC$formatting$switch_clean #> $MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $MC$code #> $MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"myDS\" #> #> $MC$clean_data #> $MC$clean_data$enabled #> [1] TRUE #> #> $MC$clean_data$default #> [1] TRUE #> #> $MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $UD #> $UD$isgood #> [1] TRUE #> #> $UD$clean #> NULL #> #> $UD$load_msg #> NULL #> #> $UD$data_file_local #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/test_data/TEST_DATA.xlsx\" #> #> $UD$data_file_ext #> [1] \".xlsx\" #> #> $UD$data_file #> [1] \"TEST_DATA.xlsx\" #> #> $UD$sheet #> [1] \"DATA\" #> #> $UD$sheets #> [1] \"DATA\" \"DDT\" #> #> $UD$code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #> #> $UD$object_name #> [1] \"myDS\" #> #> $UD$checksum #> [1] \"897d952fecbc804999396a96f9df4b20\" #> #> $UD$contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> #> $MOD_TYPE #> [1] \"UD\" #> #> $id #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml\" #>"},{"path":"/reference/UD_ds_read.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate Code and Load DS — UD_ds_read","title":"Generate Code and Load DS — UD_ds_read","text":"Generates code loading dataset returns code contents","code":""},{"path":"/reference/UD_ds_read.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate Code and Load DS — UD_ds_read","text":"","code":"UD_ds_read( state, data_file_ext = NULL, data_file_local = NULL, data_file = NULL, sheets = NULL, sheet = NULL )"},{"path":"/reference/UD_ds_read.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate Code and Load DS — UD_ds_read","text":"state UD state UD_fetch_state() data_file_ext File extension uploaded file (e.g. \"xlsx\", \"csv\", etc). data_file_local Full path data file server. data_file Dataset file name without path. sheets uploaded file excel file, character vector sheets present file. sheet uploaded file excel file, currently selected sheet.","code":""},{"path":"/reference/UD_ds_read.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate Code and Load DS — UD_ds_read","text":"list elements dataset (contents, object_name, code, isgood)","code":""},{"path":"/reference/UD_ds_read.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate Code and Load DS — UD_ds_read","text":"","code":"# We need a module state object to use this function: id=\"UD\" sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 state = sess_res$state # This is the full path to a test data file: data_file_local = system.file(package=\"formods\", \"test_data\", \"TEST_DATA.xlsx\") # Excel file extension data_file_ext = \"xlsx\" # Base file name data_file = \"TEST_DATA.xlsx\" # Excel files need a sheet specification: sheet = \"DATA\" # We will also attach the sheets along with it sheets = readxl::excel_sheets(data_file_local) ds_read_res = UD_ds_read(state, data_file_ext = data_file_ext, data_file_local = data_file_local, data_file = data_file, sheets = sheets, sheet = sheet) ds_read_res #> $contents #> # A tibble: 10,680 × 33 #> ID TIME_DY TIME_HR NTIME_DY NTIME_HR TIME AMT DV RECDESC DOSE #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> <dbl> #> 1 1 0 0 0 0 0 3000000 0 dose 3000000 #> 2 1 0 0 0 0 0 0 1250 BM_ng_ml 3000000 #> 3 1 0 0 0 0 0 0 0 C_ng_ml 3000000 #> 4 1 1 24 1 24 24 0 1647 BM_ng_ml 3000000 #> 5 1 1 24 1 24 24 0 690. C_ng_ml 3000000 #> 6 1 2 48 2 48 48 0 1947 BM_ng_ml 3000000 #> 7 1 2 48 2 48 48 0 588. C_ng_ml 3000000 #> 8 1 3 72 3 72 72 0 2170 BM_ng_ml 3000000 #> 9 1 3 72 3 72 72 0 506. C_ng_ml 3000000 #> 10 1 4 96 4 96 96 0 2332 BM_ng_ml 3000000 #> # ℹ 10,670 more rows #> # ℹ 23 more variables: DOSE_STR <chr>, Cohort <chr>, ROUTE <chr>, WT <dbl>, #> # SUBTYPE <chr>, SEX <chr>, F1 <dbl>, ka <dbl>, CL <dbl>, Vc <dbl>, Vp <dbl>, #> # Q <dbl>, BM_IC <dbl>, kdeg_BM <dbl>, Emax <dbl>, EC50 <dbl>, CMT <chr>, #> # DUR <dbl>, EVID <dbl>, NDose <chr>, DOSE_NUM <dbl>, SUBTYPE_ID <dbl>, #> # SEX_ID <dbl> #> #> $object_name #> [1] \"myDS\" #> #> $isgood #> [1] TRUE #> #> $code #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\" #>"},{"path":"/reference/UD_fetch_code.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Code — UD_fetch_code","title":"Fetch Module Code — UD_fetch_code","text":"Fetches code generate results seen app","code":""},{"path":"/reference/UD_fetch_code.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Code — UD_fetch_code","text":"","code":"UD_fetch_code(state)"},{"path":"/reference/UD_fetch_code.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Code — UD_fetch_code","text":"state UD state UD_fetch_state()","code":""},{"path":"/reference/UD_fetch_code.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Code — UD_fetch_code","text":"Character object vector lines code","code":""},{"path":"/reference/UD_fetch_code.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Code — UD_fetch_code","text":"","code":"# This creates a session variable that will be available in Shiny state = UD_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 UD_fetch_code(state) #> [1] \"myDS = readxl::read_excel(path=\\\"TEST_DATA.xlsx\\\", sheet=\\\"DATA\\\")\\nmyDS = janitor::clean_names(myDS, case=\\\"none\\\")\""},{"path":"/reference/UD_fetch_ds.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Module Datasets — UD_fetch_ds","title":"Fetch Module Datasets — UD_fetch_ds","text":"Fetches datasets contained module.","code":""},{"path":"/reference/UD_fetch_ds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Module Datasets — UD_fetch_ds","text":"","code":"UD_fetch_ds(state)"},{"path":"/reference/UD_fetch_ds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Module Datasets — UD_fetch_ds","text":"state UD state UD_fetch_state()","code":""},{"path":"/reference/UD_fetch_ds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Module Datasets — UD_fetch_ds","text":"Character object vector lines code list containing following elements isgood: Return status function. hasds: Boolean indicator module datasets msgs: Messages passed back user. ds: List datasets. list element name R-object dataset. element following structure: label: Text label dataset MOD_TYPE: Short name type module. id: module ID DS: Dataframe containing actual dataset. DSMETA: Metadata describing DS, see FM_fetch_ds() details format. code: Complete code build dataset. checksum: Module checksum. DSchecksum: Dataset checksum.","code":""},{"path":"/reference/UD_fetch_ds.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Module Datasets — UD_fetch_ds","text":"","code":"# YAML configuration files from the package: FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\") # This is the module id: id = \"UD\" # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session input = sess_res$input state = UD_fetch_state( id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file ) #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 ds_res = UD_fetch_ds(state)"},{"path":"/reference/UD_fetch_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch Upload Data State — UD_fetch_state","title":"Fetch Upload Data State — UD_fetch_state","text":"Merges default app options changes made UI","code":""},{"path":"/reference/UD_fetch_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch Upload Data State — UD_fetch_state","text":"","code":"UD_fetch_state(id, id_ASM, input, session, FM_yaml_file, MOD_yaml_file)"},{"path":"/reference/UD_fetch_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch Upload Data State — UD_fetch_state","text":"id Shiny module ID id_ASM ID string app state management module used save load app states input Shiny input variable session Shiny session variable FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section.","code":""},{"path":"/reference/UD_fetch_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch Upload Data State — UD_fetch_state","text":"list containing current state app including default values yaml file well changes made user. list following structure: yaml: Full contents supplied yaml file. MC: Module components yaml file. DS: Loaded dataset following elements isgood: Boolean object indicating file successfully loaded. load_msg: Text message indicated success problems encountered uploading file. data_file_local: Full path data file server. data_file: Dataset file name without path. data_file_ext: File extension uploaded file. sheet: uploaded file excel file, currently selected sheet. sheets: uploaded file excel file, character vector sheets present file. contents: Data frame containting contents data file. checksum: MD5 sum contents element can used detect changes loaded file. MOD_TYPE: Character data containing type module \"UD\" id: Character data containing module id module session variable. FM_yaml_file: App configuration file FM main section. MOD_yaml_file: Module configuration file MC main section.","code":""},{"path":"/reference/UD_fetch_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch Upload Data State — UD_fetch_state","text":"","code":"# YAML configuration files from the package: FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\") MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\") # This is the module id: id = \"UD\" # Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session input = sess_res$input state = UD_fetch_state( id = id, input = input, session = session, FM_yaml_file = FM_yaml_file, MOD_yaml_file = MOD_yaml_file ) #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20"},{"path":"/reference/UD_init_state.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialize UD Module State — UD_init_state","title":"Initialize UD Module State — UD_init_state","text":"Creates list initialized module state","code":""},{"path":"/reference/UD_init_state.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialize UD Module State — UD_init_state","text":"","code":"UD_init_state(FM_yaml_file, MOD_yaml_file, id, session)"},{"path":"/reference/UD_init_state.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialize UD Module State — UD_init_state","text":"FM_yaml_file App configuration file FM main section. MOD_yaml_file Module configuration file MC main section. id ID string module. session Shiny session variable","code":""},{"path":"/reference/UD_init_state.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Initialize UD Module State — UD_init_state","text":"list containing empty UD state","code":""},{"path":"/reference/UD_init_state.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Initialize UD Module State — UD_init_state","text":"","code":"# Within shiny a session variable will exist, # this creates one here for testing purposes: sess_res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 session = sess_res$session state = UD_init_state( FM_yaml_file = system.file(package = \"formods\", \"templates\", \"formods.yaml\"), MOD_yaml_file = system.file(package = \"formods\", \"templates\", \"UD.yaml\"), id = \"UD\", session = session) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized state #> $yaml #> $yaml$FM #> $yaml$FM$include #> $yaml$FM$include$files #> $yaml$FM$include$files[[1]] #> $yaml$FM$include$files[[1]]$file #> $yaml$FM$include$files[[1]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.docx\\\")\" #> #> $yaml$FM$include$files[[1]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.docx\\\")\" #> #> #> #> $yaml$FM$include$files[[2]] #> $yaml$FM$include$files[[2]]$file #> $yaml$FM$include$files[[2]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.pptx\\\")\" #> #> $yaml$FM$include$files[[2]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.pptx\\\")\" #> #> #> #> $yaml$FM$include$files[[3]] #> $yaml$FM$include$files[[3]]$file #> $yaml$FM$include$files[[3]]$file$source #> [1] \"file.path(system.file(package=\\\"onbrand\\\"), \\\"templates\\\", \\\"report.yaml\\\")\" #> #> $yaml$FM$include$files[[3]]$file$dest #> [1] \"file.path(\\\"config\\\",\\\"report.yaml\\\")\" #> #> #> #> #> #> $yaml$FM$deployed #> [1] FALSE #> #> $yaml$FM$code #> $yaml$FM$code$theme #> [1] \"vibrant_ink\" #> #> $yaml$FM$code$showLineNumbers #> [1] TRUE #> #> $yaml$FM$code$gen_file #> [1] \"run_analysis.R\" #> #> $yaml$FM$code$gen_preamble #> [1] \"# formods automated output ------------------------------------------------\\n# https://formods.ubiquity.tools/\\nrm(list=ls())\" #> #> $yaml$FM$code$packages #> [1] \"onbrand\" \"writexl\" #> #> #> $yaml$FM$notifications #> $yaml$FM$notifications$config #> $yaml$FM$notifications$config$success #> $yaml$FM$notifications$config$success$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$success$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$success$background #> [1] \"#5bb85b\" #> #> #> $yaml$FM$notifications$config$failure #> $yaml$FM$notifications$config$failure$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$failure$background #> [1] \"#d9534f\" #> #> #> $yaml$FM$notifications$config$info #> $yaml$FM$notifications$config$info$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$info$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$info$background #> [1] \"#5bc0de\" #> #> #> $yaml$FM$notifications$config$warning #> $yaml$FM$notifications$config$warning$useFontAwesome #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$useIcon #> [1] FALSE #> #> $yaml$FM$notifications$config$warning$background #> [1] \"#f0ac4d\" #> #> #> #> #> $yaml$FM$reporting #> $yaml$FM$reporting$enabled #> [1] TRUE #> #> $yaml$FM$reporting$content_init #> $yaml$FM$reporting$content_init$xlsx #> [1] \"rpt = list(summary = NULL,\\n sheets = list())\" #> #> $yaml$FM$reporting$content_init$docx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.docx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> $yaml$FM$reporting$content_init$pptx #> [1] \"rpt = onbrand::read_template(\\n template = file.path(\\\"config\\\", \\\"report.pptx\\\"),\\n mapping = file.path(\\\"config\\\", \\\"report.yaml\\\"))\" #> #> #> #> $yaml$FM$ui #> $yaml$FM$ui$button_style #> [1] \"fill\" #> #> $yaml$FM$ui$select_size #> [1] 10 #> #> $yaml$FM$ui$color_green #> [1] \"#00BB8A\" #> #> $yaml$FM$ui$color_red #> [1] \"#FF475E\" #> #> $yaml$FM$ui$color_blue #> [1] \"#0088FF\" #> #> $yaml$FM$ui$color_purple #> [1] \"#bd2cf4\" #> #> #> $yaml$FM$data_meta #> $yaml$FM$data_meta$data_header #> [1] \"<span style='color:===COLOR==='><b>===NAME===<\/b><br/><font size='-3'>===LABEL===<\/font><\/span>\" #> #> $yaml$FM$data_meta$subtext #> [1] \"===LABEL===: ===RANGE===\" #> #> $yaml$FM$data_meta$many_sep #> [1] \",⋅⋅⋅,\" #> #> $yaml$FM$data_meta$data_types #> $yaml$FM$data_meta$data_types$character #> $yaml$FM$data_meta$data_types$character$color #> [1] \"#DD4B39\" #> #> $yaml$FM$data_meta$data_types$character$label #> [1] \"text\" #> #> #> $yaml$FM$data_meta$data_types$double #> $yaml$FM$data_meta$data_types$double$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$double$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$integer #> $yaml$FM$data_meta$data_types$integer$color #> [1] \"#3C8DBC\" #> #> $yaml$FM$data_meta$data_types$integer$label #> [1] \"num\" #> #> #> $yaml$FM$data_meta$data_types$other #> $yaml$FM$data_meta$data_types$other$color #> [1] \"black\" #> #> $yaml$FM$data_meta$data_types$other$label #> [1] \"other\" #> #> #> #> #> $yaml$FM$labels #> $yaml$FM$labels$default_ds #> [1] \"Original data set\" #> #> #> $yaml$FM$user_files #> $yaml$FM$user_files$use_tmpdir #> [1] TRUE #> #> #> $yaml$FM$logging #> $yaml$FM$logging$enabled #> [1] TRUE #> #> $yaml$FM$logging$timestamp #> [1] TRUE #> #> $yaml$FM$logging$timestamp_fmt #> [1] \"%Y-%m-%d %H:%M:%S\" #> #> $yaml$FM$logging$log_file #> [1] \"formods_log.txt\" #> #> $yaml$FM$logging$console #> [1] TRUE #> #> #> #> #> $MC #> $MC$compact #> $MC$compact$code #> [1] FALSE #> #> $MC$compact$preview #> [1] TRUE #> #> #> $MC$reporting #> $MC$reporting$enabled #> [1] FALSE #> #> $MC$reporting$priority #> [1] 1 #> #> #> $MC$labels #> $MC$labels$default_ds #> [1] \"Original data set\" #> #> $MC$labels$upload_button #> [1] \"Select file\" #> #> $MC$labels$tab_main #> [1] \"Upload file\" #> #> $MC$labels$tab_code #> [1] \"Code\" #> #> $MC$labels$tab_preview #> [1] \"Data preview\" #> #> $MC$labels$switch_clean #> [1] \"Clean column names on upload\" #> #> $MC$labels$msg_bad_extension #> [1] \"Incorrect file extension (===EXT===). Unable to load file ===FILE===.\\nOnly the following extesions are allowed: ===ALLOWEDEXT===.\" #> #> #> $MC$tooltips #> $MC$tooltips$include #> [1] TRUE #> #> $MC$tooltips$show_code #> [1] \"Show data reading code\" #> #> #> $MC$formatting #> $MC$formatting$preview #> $MC$formatting$preview$width #> [1] 800 #> #> $MC$formatting$preview$height #> [1] 500 #> #> #> $MC$formatting$code #> $MC$formatting$code$width #> [1] 500 #> #> $MC$formatting$code$height #> [1] 200 #> #> #> $MC$formatting$switch_clean #> $MC$formatting$switch_clean$tooltip #> [1] \"Strange characters in column names can cause problems. When switched on, this will clean up the column headers and fix those that might break things.\" #> #> $MC$formatting$switch_clean$tooltip_position #> [1] \"bottom\" #> #> #> #> $MC$allowed_extensions #> [1] \"csv\" \"tsv\" \"xls\" \"xlsx\" #> #> $MC$code #> $MC$code$packages #> [1] \"readxl\" \"readr\" \"janitor\" #> #> $MC$code$readOnly #> [1] TRUE #> #> $MC$code$mode #> [1] \"r\" #> #> $MC$code$preamble #> [1] \"# Loading data ------------------------------------------------------------\" #> #> #> $MC$ds_object_name #> [1] \"myDS\" #> #> $MC$clean_data #> $MC$clean_data$enabled #> [1] TRUE #> #> $MC$clean_data$default #> [1] TRUE #> #> $MC$clean_data$code #> [1] \"# Make sure you put whatever packages you use here in the packages section\\n# above.\\n#\\n# contents - data frame containing the loaded dataset.\\n# code - code used to load the dataset you need to append any cleaning\\n# code you generate here.\\n# object_name - Name of the dataset object used in generated code.\\nif(system.file(package=\\\"janitor\\\") != \\\"\\\"){\\n contents = janitor::clean_names(contents, case=\\\"none\\\")\\n code = paste0(code, '\\\\n', object_name, ' = janitor::clean_names(', object_name,', case=\\\"none\\\")')\\n}\" #> #> #> #> $UD #> $UD$isgood #> [1] FALSE #> #> $UD$clean #> [1] TRUE #> #> $UD$load_msg #> NULL #> #> $UD$data_file_local #> NULL #> #> $UD$data_file_ext #> NULL #> #> $UD$data_file #> NULL #> #> $UD$sheet #> NULL #> #> $UD$sheets #> NULL #> #> $UD$code #> [1] \"\" #> #> $UD$object_name #> [1] \"myDS\" #> #> $UD$checksum #> [1] \"451f5a07b45f62763a93eb83c0bdbc3c\" #> #> $UD$contents #> NULL #> #> #> $MOD_TYPE #> [1] \"UD\" #> #> $id #> [1] \"UD\" #> #> $FM_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/formods.yaml\" #> #> $MOD_yaml_file #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/UD.yaml\" #>"},{"path":"/reference/UD_test_mksession.html","id":null,"dir":"Reference","previous_headings":"","what":"Populate Session Data for Module Testing — UD_test_mksession","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"Populates supplied session variable testing.","code":""},{"path":"/reference/UD_test_mksession.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"","code":"UD_test_mksession(session, id = \"UD\")"},{"path":"/reference/UD_test_mksession.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"session Shiny session variable (app) list (outside app) id ID string corresponds ID used call modules UI elements","code":""},{"path":"/reference/UD_test_mksession.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"list following elements isgood: Boolean indicating exit status function. session: value Shiny session variable (app) list (outside app) initialization. input: value shiny input end session initialization. state: App state. rsc: react_state components.","code":""},{"path":"/reference/UD_test_mksession.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Populate Session Data for Module Testing — UD_test_mksession","text":"","code":"res = UD_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20"},{"path":"/reference/autocast.html","id":null,"dir":"Reference","previous_headings":"","what":"Automatically Cast UI Input Variable — autocast","title":"Automatically Cast UI Input Variable — autocast","text":"Takes UI input tries figure numeric text","code":""},{"path":"/reference/autocast.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Automatically Cast UI Input Variable — autocast","text":"","code":"autocast(ui_input, quote_char = TRUE)"},{"path":"/reference/autocast.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Automatically Cast UI Input Variable — autocast","text":"ui_input UI input shiny form quote_char TRUE include double quotes character string","code":""},{"path":"/reference/autocast.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Automatically Cast UI Input Variable — autocast","text":"Best guess type casting applied ui_input","code":""},{"path":"/reference/autocast.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Automatically Cast UI Input Variable — autocast","text":"","code":"number = autocast('10') text = autocast('ten') #> Warning: NAs introduced by coercion"},{"path":"/reference/dw_eval_element.html","id":null,"dir":"Reference","previous_headings":"","what":"Evaluates Data Wrangling Generated Code — dw_eval_element","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"Takes current state string containing data wranlging command evaluates .","code":""},{"path":"/reference/dw_eval_element.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"","code":"dw_eval_element(state, cmd)"},{"path":"/reference/dw_eval_element.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"state DW state DW_fetch_state() cmd string containing data wrangling command","code":""},{"path":"/reference/dw_eval_element.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"list following elements isgood: Return status function. msgs: Messages passed back user. DS: Wrangled dataset.","code":""},{"path":"/reference/dw_eval_element.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Evaluates Data Wrangling Generated Code — dw_eval_element","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/dwrs_builder.html","id":null,"dir":"Reference","previous_headings":"","what":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"Takes current ui elements constructs appropriate data wrangling command user input.","code":""},{"path":"/reference/dwrs_builder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"","code":"dwrs_builder(state)"},{"path":"/reference/dwrs_builder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"state DW state DW_fetch_state()","code":""},{"path":"/reference/dwrs_builder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"list containing following elements isgood: Return status function cmd: Data wrangling R command action: action performed desc: Verbose description action msgs: Messages passed back user","code":""},{"path":"/reference/dwrs_builder.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Builds a Data Wrangling R Statement From ui Elements: — dwrs_builder","text":"","code":"library(formods) # The example requires a formods DW state object state = DW_test_mksession(session=list())$state #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b state[[\"DW\"]][[\"ui\"]][[\"select_dw_element\"]] = \"filter\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_column\"]] = \"EVID\" state[[\"DW\"]][[\"ui\"]][[\"select_fds_filter_operator\"]] = \"==\" state[[\"DW\"]][[\"ui\"]][[\"fds_filter_rhs\"]] = 0 # This builds the data wrangling statement based on # elemets scraped from the UI dwb_res = dwrs_builder(state) # Here we evaluate the resulting command: dwee_res = dw_eval_element(state, dwb_res[[\"cmd\"]]) # Next we add this wrangling element to the state state = DW_add_wrangling_element(state, dwb_res, dwee_res) #> → DW: module checksum updated:28a679e132fa3cd0e47f9d941d4facdc # This creates a new data view and makes it active state = DW_new_view(state) # Here we can pluck out that data view from the state current_view = DW_fetch_current_view(state) # This will update the key in this view current_view[[\"key\"]] = \"My new view\" # And this will place it back into the state state = DW_set_current_view(state, current_view) #> → DW: module checksum updated:18070dc40a79230360b4e93daa19a2cc"},{"path":"/reference/fers_builder.html","id":null,"dir":"Reference","previous_headings":"","what":"Builds a Figure Element R Statement From UI Elements: — fers_builder","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"Takes current ui elements constructs appropriate ggplot commands forom user input. plot commands assume existance ggplot object p.","code":""},{"path":"/reference/fers_builder.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"","code":"fers_builder(state)"},{"path":"/reference/fers_builder.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"state FG state FG_fetch_state()","code":""},{"path":"/reference/fers_builder.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"list containing following elements isgood: Return status function. cmd: ggplot R command character string element: type element added desc: Verbose description element msgs: Messages passed back user","code":""},{"path":"/reference/fers_builder.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Builds a Figure Element R Statement From UI Elements: — fers_builder","text":"","code":"sess_res = FG_test_mksession(session=list(), full_session=FALSE) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → FG: dest: file.path(\"config\",\"report.docx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → FG: dest: file.path(\"config\",\"report.pptx\") #> → FG: including file #> → FG: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → FG: dest: file.path(\"config\",\"report.yaml\") #> → FG: State initialized #> → FG: module checksum updated:608011f4c5b36bb2195e103294e96c53 #> → FG: module checksum updated:dab7d2ac1d1f43247b9903a7ed237fea #> → FG: module checksum updated:7ad2cd8b573aeb3b5a34440657cd7cbe #> → FG: module checksum updated:2ec9751ef4bcbb8426eee00e86196255 state = sess_res$state fb_res = fers_builder(state)"},{"path":"/reference/fetch_hold.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Hold Status UI Element Supplied — fetch_hold","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"buttons clicked change state system, UI components detect change correctly. triggers put hold. fetch hold status specified inputId","code":""},{"path":"/reference/fetch_hold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"","code":"fetch_hold(state, inputId = NULL)"},{"path":"/reference/fetch_hold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"state module state current ui elements populated inputId input ID UI element put hold","code":""},{"path":"/reference/fetch_hold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"Boolean value hold status","code":""},{"path":"/reference/fetch_hold.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Hold Status UI Element Supplied — fetch_hold","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # For this example we also need a state variable state = sess_res$state # This sets a hold on the specified inputID. This is normally done in # your XX_fetch_state() function. state = set_hold(state, inputId = \"select_dw_views\") # This will fetch the hold status of the specified inputID. fetch_hold(state, inputId = \"select_dw_views\") #> [1] TRUE # This will remove the hold and is normally done in one of the UI outputs # with a priority set to ensure it happens after the rest of the UI has # refreshed. state = remove_hold(state, session, inputId = \"select_dw_views\")"},{"path":"/reference/fetch_package_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetches the Current Version of Pacakge — fetch_package_version","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"specified package version extracted returned. can simply version installed CRAN development version GitHub used details returned.","code":""},{"path":"/reference/fetch_package_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"","code":"fetch_package_version(pkgname)"},{"path":"/reference/fetch_package_version.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"pkgname Name package","code":""},{"path":"/reference/fetch_package_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"String version information","code":""},{"path":"/reference/fetch_package_version.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetches the Current Version of Pacakge — fetch_package_version","text":"","code":"# This package should exist fetch_package_version('digest') #> $isgood #> [1] TRUE #> #> $msgs #> NULL #> #> $version_verb #> [1] \"0.6.31 (2022-12-11, CRAN (R 4.2.0))\" #> #> $version #> [1] \"0.6.31\" #> # This package should not exist fetch_package_version('bad package name') #> $isgood #> [1] FALSE #> #> $msgs #> [1] \"The package: bad package name was not found. You may need to load it first.\" #> #> $version_verb #> [1] \"NA\" #> #> $version #> [1] \"NA\" #>"},{"path":"/reference/formods.html","id":null,"dir":"Reference","previous_headings":"","what":"formods: Shiny modules for common tasks. — formods","title":"formods: Shiny modules for common tasks. — formods","text":"Shiny apps can often make use key elements, package provides modules common tasks (data upload, wrangling data, figure generation saving app state). modules can react interact well generate code create reproducible analyses.","code":""},{"path":[]},{"path":"/reference/formods.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"formods: Shiny modules for common tasks. — formods","text":"Maintainer: John Harrold john.m.harrold@gmail.com (ORCID)","code":""},{"path":"/reference/has_changed.html","id":null,"dir":"Reference","previous_headings":"","what":"Detect if a UI element has changed — has_changed","title":"Detect if a UI element has changed — has_changed","text":"Takes UI element value older value determines modified","code":""},{"path":"/reference/has_changed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Detect if a UI element has changed — has_changed","text":"","code":"has_changed(ui_val = NULL, old_val = NULL, init_value = c(\"\"))"},{"path":"/reference/has_changed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Detect if a UI element has changed — has_changed","text":"ui_val Current value UI. old_val Last value element. init_value Default value reading UI data defined.","code":""},{"path":"/reference/has_changed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Detect if a UI element has changed — has_changed","text":"Boolean result comparison","code":""},{"path":"/reference/has_changed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Detect if a UI element has changed — has_changed","text":"","code":"changed_true = has_changed(ui_val = \"a\", old_val = \"\") changed_true #> [1] TRUE changed_false = has_changed(ui_val = \"a\", old_val = \"a\") changed_false #> [1] FALSE"},{"path":"/reference/icon_link.html","id":null,"dir":"Reference","previous_headings":"","what":"Creates Icon Link — icon_link","title":"Creates Icon Link — icon_link","text":"Creates link Shiny icon","code":""},{"path":"/reference/icon_link.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Creates Icon Link — icon_link","text":"","code":"icon_link(href, target = \"_blank\", icon_name = \"circle-info\")"},{"path":"/reference/icon_link.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Creates Icon Link — icon_link","text":"href URL link . target New tab name. icon_name Name icon use (arguemnt shiny::icon, default: \"circle-info\")","code":""},{"path":"/reference/icon_link.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Creates Icon Link — icon_link","text":"list shiny.tag class can converted HTML string via .character() saved file save_html()","code":""},{"path":"/reference/icon_link.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Creates Icon Link — icon_link","text":"","code":"icon_link(href=\"https://formods.ubiquity.tools\") #> <a href=\"https://formods.ubiquity.tools\" target=\"_blank\"> #> <i class=\"fas fa-circle-info\" role=\"presentation\" aria-label=\"circle-info icon\"><\/i> #> <\/a>"},{"path":"/reference/is_installed.html","id":null,"dir":"Reference","previous_headings":"","what":"Determines if a Package is Installed — is_installed","title":"Determines if a Package is Installed — is_installed","text":"Determines specified package installed.","code":""},{"path":"/reference/is_installed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Determines if a Package is Installed — is_installed","text":"","code":"is_installed(pkgname)"},{"path":"/reference/is_installed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Determines if a Package is Installed — is_installed","text":"pkgname Name package","code":""},{"path":"/reference/is_installed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Determines if a Package is Installed — is_installed","text":"Logical indicating packages installed ","code":""},{"path":"/reference/is_installed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Determines if a Package is Installed — is_installed","text":"","code":"# This package should exist is_installed('digest') #> [1] TRUE # This package should not exist is_installed('bad package name') #> [1] FALSE"},{"path":"/reference/new_module_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Makes Template Files for formods New Module — new_module_template","title":"Makes Template Files for formods New Module — new_module_template","text":"want create new formods module function create template files .","code":""},{"path":"/reference/new_module_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Makes Template Files for formods New Module — new_module_template","text":"","code":"new_module_template( SN = \"NM\", Module_Name = \"New Module\", package = \"pkgname\", element = \"analysis\", file_dir = tempdir() )"},{"path":"/reference/new_module_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Makes Template Files for formods New Module — new_module_template","text":"SN Module short name Module_Name Module long name package Name package contain module element call thing module provides example FG module provides \"figures\", DW module provides \"data views\". file_dir Directory save file","code":""},{"path":"/reference/new_module_template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Makes Template Files for formods New Module — new_module_template","text":"list following elements: mc: Module components. server: Server.R file. yaml: Yaml configureation file. list paths respective files: source: Template source. dest: Destination file name. dest_full: Full path destination file name.","code":""},{"path":"/reference/new_module_template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Makes Template Files for formods New Module — new_module_template","text":"","code":"new_module_template() #> $mc #> $mc$source #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ZZ_module_components.R\" #> #> $mc$dest #> [1] \"NM_module_components.R\" #> #> $mc$dest_full #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/NM_module_components.R\" #> #> #> $server #> $server$source #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ZZ_Server.R\" #> #> $server$dest #> [1] \"NM_Server.R\" #> #> $server$dest_full #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/NM_Server.R\" #> #> #> $yaml #> $yaml$source #> [1] \"/private/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T/RtmpIGKCXm/temp_libpath157fd35f26e02/formods/templates/ZZ.yaml\" #> #> $yaml$dest #> [1] \"NM.yaml\" #> #> $yaml$dest_full #> [1] \"/var/folders/l9/6pm7xq5j1hn6l00zrs22j6mc0000gn/T//RtmpAJjcxS/NM.yaml\" #> #>"},{"path":"/reference/remove_hold.html","id":null,"dir":"Reference","previous_headings":"","what":"Removes Hold on UI Element — remove_hold","title":"Removes Hold on UI Element — remove_hold","text":"buttons clicked change state system, UI components detect change correctly. triggers put hold. remove hold UI components updated.","code":""},{"path":"/reference/remove_hold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Removes Hold on UI Element — remove_hold","text":"","code":"remove_hold(state, session, inputId)"},{"path":"/reference/remove_hold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Removes Hold on UI Element — remove_hold","text":"state module state current ui elements populated session Shiny session variable inputId input ID UI element put hold","code":""},{"path":"/reference/remove_hold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Removes Hold on UI Element — remove_hold","text":"return value, called remove holds.","code":""},{"path":"/reference/remove_hold.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Removes Hold on UI Element — remove_hold","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # For this example we also need a state variable state = sess_res$state # This sets a hold on the specified inputID. This is normally done in # your XX_fetch_state() function. state = set_hold(state, inputId = \"select_dw_views\") # This will fetch the hold status of the specified inputID. fetch_hold(state, inputId = \"select_dw_views\") #> [1] TRUE # This will remove the hold and is normally done in one of the UI outputs # with a priority set to ensure it happens after the rest of the UI has # refreshed. state = remove_hold(state, session, inputId = \"select_dw_views\")"},{"path":"/reference/set_hold.html","id":null,"dir":"Reference","previous_headings":"","what":"Sets Hold on One or All UI Elements — set_hold","title":"Sets Hold on One or All UI Elements — set_hold","text":"buttons clicked change state system, UI components detect change correctly. triggers put hold. set hold specified inputId ids value set NULL","code":""},{"path":"/reference/set_hold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sets Hold on One or All UI Elements — set_hold","text":"","code":"set_hold(state, inputId = NULL)"},{"path":"/reference/set_hold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sets Hold on One or All UI Elements — set_hold","text":"state module state current ui elements populated inputId input ID UI element put hold NULL hold IDs module","code":""},{"path":"/reference/set_hold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sets Hold on One or All UI Elements — set_hold","text":"state hold holds set","code":""},{"path":"/reference/set_hold.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sets Hold on One or All UI Elements — set_hold","text":"","code":"# Within shiny both session and input variables will exist, # this creates examples here for testing purposes: sess_res = DW_test_mksession(session=list()) #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → UD: dest: file.path(\"config\",\"report.docx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → UD: dest: file.path(\"config\",\"report.pptx\") #> → UD: including file #> → UD: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → UD: dest: file.path(\"config\",\"report.yaml\") #> → UD: State initialized #> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20 #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.docx\") #> → DW: dest: file.path(\"config\",\"report.docx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.pptx\") #> → DW: dest: file.path(\"config\",\"report.pptx\") #> → DW: including file #> → DW: source: file.path(system.file(package=\"onbrand\"), \"templates\", \"report.yaml\") #> → DW: dest: file.path(\"config\",\"report.yaml\") #> → DW: State initialized #> → DW: module checksum updated:5b0f0b05ee3ac7336a74c564bb6efdad #> → DW: module checksum updated:65801ab4b3c645aabf7edf91fc2f0d2c #> → DW: module checksum updated:7fb2dd3b16b1780c4c24f64d658dd7c7 #> → DW: module checksum updated:5ab04ea00be44c0040695a4ed6243c90 #> → DW: module checksum updated:960db107cfe9db93578f79f0ae6283e2 #> → DW: module checksum updated:f0b5d122dcb04f207cba233253b61c4b #> → DW: module checksum updated:189ed77a84bd9fcdd7b26abff8bea34a #> → DW: module checksum updated:669ec77d50652669cd3fcfd949469b37 #> → DW: module checksum updated:dd6cafa0be3b6b195d230a11e9f07f9f #> → DW: module checksum updated:5c2022c376ca8f56b839347156559890 #> → DW: module checksum updated:43640500a04674debd8e2399056c384a #> → DW: module checksum updated:f81c45ac1ef4e7b43153d8c8eaf7aed6 #> → DW: module checksum updated:207cde891d98e20c4afbb7fb5fb0aba2 #> → DW: module checksum updated:0a673e81c01cbbf33533dd65d6baf9e3 #> → DW: module checksum updated:af3f3aefd0115ed9dfdd4d6ef9d5182f #> → DW: module checksum updated:b0ccaee21e859322df0bf79d00c4b347 #> → DW: module checksum updated:2d3d6e9e38be6dea813b2d4d679e34b5 #> → DW: module checksum updated:2b60dd49b48a4e65200dc7241ad270e3 #> → DW: module checksum updated:3c92f397181a4fcdbdf2bd7dd7425e77 #> → DW: module checksum updated:92b81d7573def603649370b87c123b55 #> → DW: module checksum updated:9210264aabc0339e832b0c6bcfda32af #> → DW: module checksum updated:fe62fde1e7e738a1a35c479de9d5007b #> → DW: module checksum updated:ff3edcd4c1e58c96ea2707361916ffbc #> → DW: module checksum updated:b6cdfcef0432c5d9b1fa2bd46122ffa2 #> → DW: module checksum updated:4fa4283f1fd8fd6cf6e6e7df0669723a #> → DW: module checksum updated:cf3e139cef554b2d09dca619ee6aff41 #> → DW: module checksum updated:a9154d91a9e4b5d21f9585a6f68dd083 #> → DW: module checksum updated:4b5c6ad66658ddfa92d10ae1b0b7afa8 #> → DW: module checksum updated:591ac875a490b66a1fa7f4e7d4ba1c62 #> → DW: module checksum updated:afa3ca309cc3e6a48f542f4e8eadd54a #> → DW: module checksum updated:5c918dd4f53a4f1e56115abb09c4f332 #> → DW: module checksum updated:159ddf8c8cd26b178dfda5434bbecfa1 #> → DW: module checksum updated:8bb3c97e700998f2f73353189bd07831 #> → DW: module checksum updated:a1eceffec3ff7d9f9961683b3d07088b session = sess_res$session input = sess_res$input # For this example we also need a state variable state = sess_res$state # This sets a hold on the specified inputID. This is normally done in # your XX_fetch_state() function. state = set_hold(state, inputId = \"select_dw_views\") # This will fetch the hold status of the specified inputID. fetch_hold(state, inputId = \"select_dw_views\") #> [1] TRUE # This will remove the hold and is normally done in one of the UI outputs # with a priority set to ensure it happens after the rest of the UI has # refreshed. state = remove_hold(state, session, inputId = \"select_dw_views\")"},{"path":"/reference/unfactor.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove Factor From Object — unfactor","title":"Remove Factor From Object — unfactor","text":"Takes object factor returns unfactored vector type value removed","code":""},{"path":"/reference/unfactor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove Factor From Object — unfactor","text":"","code":"unfactor(fctobj)"},{"path":"/reference/unfactor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove Factor From Object — unfactor","text":"fctobj Factorized object","code":""},{"path":"/reference/unfactor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove Factor From Object — unfactor","text":"Object factors removed","code":""},{"path":"/reference/unfactor.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove Factor From Object — unfactor","text":"","code":"df = data.frame( text = c(\"a\", \"b\", \"c\"), float = c( 1 , 2 , 3 )) df$float = as.factor(df$float) # This is a factor df$float #> [1] 1 2 3 #> Levels: 1 2 3 # This is not a factor unfactor(df$float) #> [1] 1 2 3"},{"path":"/reference/use_formods.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Module Templates in a Package Repository — use_formods","title":"Create Module Templates in a Package Repository — use_formods","text":"developing package within repository (.e. git) want create new formods module function create template files install correct location.","code":""},{"path":"/reference/use_formods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Module Templates in a Package Repository — use_formods","text":"","code":"use_formods( SN = \"NM\", Module_Name = \"New Module\", package = \"pkgname\", element = \"analysis\", overwrite = FALSE, repo_root = NULL )"},{"path":"/reference/use_formods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Module Templates in a Package Repository — use_formods","text":"SN Module short name Module_Name Module long name package Name package contain module element call thing module provides example FG module provides \"figures\", DW module provides \"data views\" overwrite Boolean indicate overwrite files repo_root Root repository.","code":""},{"path":"/reference/use_formods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Module Templates in a Package Repository — use_formods","text":"return value new_module_template()","code":""},{"path":"/reference/use_formods.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Module Templates in a Package Repository — use_formods","text":"","code":"if(FALSE){ use_formods(repo_root=tempdir()) }"},{"path":"/news/index.html","id":"formods-012","dir":"Changelog","previous_headings":"","what":"formods 0.1.2","title":"formods 0.1.2","text":"development version Added new_module_template() create new module templates use_formods() automatically add files package. Updated app info ASM split uiele diferent components.","code":""},{"path":"/news/index.html","id":"formods-011","dir":"Changelog","previous_headings":"","what":"formods 0.1.1","title":"formods 0.1.1","text":"CRAN release: 2023-08-17 Initial release","code":""}]
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index 0ff123d..0838f4b 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -168,6 +168,9 @@
<url>
<loc>/reference/FM_le.html</loc>
</url>
+ <url>
+ <loc>/reference/FM_message.html</loc>
+ </url>
<url>
<loc>/reference/FM_mk_error_fig.html</loc>
</url>
diff --git a/inst/templates/ZZ_Server.R b/inst/templates/ZZ_Server.R
index 9eee335..5cd53bc 100644
--- a/inst/templates/ZZ_Server.R
+++ b/inst/templates/ZZ_Server.R
@@ -456,6 +456,7 @@
#'@param session Shiny session variable
#'@param FM_yaml_file App configuration file with FM as main section.
#'@param MOD_yaml_file Module configuration file with MC as main section.
+#'@param react_state Variable passed to server to allow reaction outside of module (\code{NULL})
#'@return list containing the current state of the app including default
#'values from the yaml file as well as any changes made by the user. The list
#'has the following structure:
@@ -776,10 +777,11 @@ code}
#'@export
#'@title Append Report Elements
-#'@description Description
+#'@description Appends report elements to a formods report.
#'@param state ===ZZ=== state from \code{===ZZ===_fetch_state()}
#'@param rpt Report with the current content of the report which will be appended to in
-#'this function. For details on the structure see the documentation for \code{\link{formods::FM_generate_report}}.
+#'this function. For details on the structure see the documentation for
+#' \code{\link[onbrand]{template_details}}
#'@param rpttype Type of report to generate (supported "xlsx", "pptx", "docx").
#'@param gen_code_only Boolean value indicating that only code should be
#'generated (\code{FALSE}).
@@ -791,7 +793,7 @@ code}
#' \item{msgs:} Messages to be passed back to the user.
#' \item{rpt:} Report with any additions passed back to the user.
#'}
-#'@seealso \code{\link{formods::FM_generate_report}}
+#'@seealso \code{\link[formods]{FM_generate_report}}
===ZZ===_append_report = function(state, rpt, rpttype, gen_code_only=FALSE){
isgood = TRUE
@@ -1014,6 +1016,7 @@ state}
#'@description Populates the supplied session variable for testing.
#'@param session Shiny session variable (in app) or a list (outside of app)
#'@param id An ID string that corresponds with the ID used to call the modules UI elements
+#'@param full_session Boolean to indicate if the full test session should be created (default \code{TRUE}).
#'@return list with the following elements
#' \itemize{
#' \item{isgood:} Boolean indicating the exit status of the function.
@@ -1024,7 +1027,7 @@ state}
#'}
#'@examples
#' sess_res = ===ZZ===_test_mksession(session=list())
-===ZZ===_test_mksession = function(session, id = "===ZZ==="){
+===ZZ===_test_mksession = function(session, id = "===ZZ===", full_session=TRUE){
isgood = TRUE
rsc = list()
diff --git a/man/FM_message.Rd b/man/FM_message.Rd
new file mode 100644
index 0000000..c350328
--- /dev/null
+++ b/man/FM_message.Rd
@@ -0,0 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/formods.R
+\name{FM_message}
+\alias{FM_message}
+\title{Show Message to User}
+\usage{
+FM_message(line, escape_braces = TRUE, entry_type = "alert")
+}
+\arguments{
+\item{line}{Text to display}
+
+\item{escape_braces}{Set to \code{TRUE} (default) to escape curly braces in the entry, set to \code{FALSE} to have the values interpreted.}
+
+\item{entry_type}{Set to either "alert"(default), "danger", "info", "success", or "warning"}
+}
+\value{
+Returns NULL
+}
+\description{
+Writes a message to the console depending on whether cli is
+installed or not.
+}
+\examples{
+mr = FM_message("This is a normal message")
+mr = FM_message("This is a danger message", entry_type="danger")
+mr = FM_message("This is a info message", entry_type="info")
+mr = FM_message("This is a success message", entry_type="success")
+mr = FM_message("This is a warning message", entry_type="warning")
+}