refactoring and documentation

Author: markomi

R/app.R

@@ -12,7 +12,7 @@ app_server <- function(input, output) {
   calc_prop <- readRDS(system.file("extdata", "calc_prop_test.rds", package = "shinysse"))
   # get module labels and then call
   mod <- get_module_registry()
-  callModule(app_intro, mod$app_intro)
+  callModule(sse_intro, mod$sse_intro)
   callModule(sse_ttest, mod$sse_ttest, calc_t_twosample, calc_t_paired)
   callModule(sse_ttest_plus, mod$sse_ttest_plus, calc_t_twosample, calc_t_paired)
   callModule(sse_prop, mod$sse_prop, calc_prop)

R/app_server.R

@@ -12,7 +12,7 @@ app_ui <- function(){
     dashboardSidebar(
       div(p(" ")),
       sidebarMenu(
-        menuItem("Introduction", tabName = mod$app_intro, icon = icon("info")),
+        menuItem("Introduction", tabName = mod$sse_intro, icon = icon("info")),
         menuItem("Two sample t-Test SSE", tabName = mod$sse_ttest, icon = icon("text-size", lib = "glyphicon")),
         menuItem("Two sample t-Test SSE + input", tabName = mod$sse_ttest_plus, icon = icon("text-size", lib = "glyphicon")),
         menuItem("Proportion Test SSE", tabName = mod$sse_prop, icon = icon("percentage"))
@@ -23,7 +23,7 @@ app_ui <- function(){
         tags$link(rel = "stylesheet", type = "text/css", href = "www/custom.css")
       ),
       tabItems(
-        app_intro_ui(mod$app_intro, label = mod$app_intro),
+        sse_intro_ui(mod$sse_intro, label = mod$sse_intro),
         sse_ttest_ui(mod$sse_ttest, label = mod$sse_ttest),
         sse_ttest_plus_ui(mod$sse_ttest_plus, label = mod$sse_ttest_plus),
         sse_prop_ui(mod$sse_prop, label = mod$sse_prop)

R/app_ui.R

@@ -1,7 +1,7 @@
 #' Evaluates power functions for power.prop.test
 #'
 #' For all pre-set combinations of n, theta, xi and alpha, this function calculates a list of powCalc
-#' objects and saves.
+#' objects and saves the list.
 #'
 #' Input parameters are optional. Defaults:
 #' * n <- seq(from = 3, to = 10000, by = 5)
@@ -14,8 +14,9 @@
 #' @param theta numeric vector containing possible range of effect sizes
 #' @param xi numeric vector containing possible range of proportions
 #' @param alpha numeric vector containing possible range of significance levels
-#'  @param save_path string inidicating where the function output should be saved
+#' @param save_path string inidicating where the function output should be saved
 #' @return list of calculated powCalc objects
+#' @seealso \code{\link{calc_t}}
 #' @export
 #'
 calc_prop <- function(n, theta, xi, alpha, save_path){

R/fun_calc_prop.R

@@ -1,7 +1,7 @@
 #' Evaluates power functions for power.t.test
 #'
 #' For all pre-set combinations of n, theta, xi and alpha, this function calculates a list of powCalc
-#' objects and saves them.
+#' objects and saves the list.
 #'
 #' Input parameters are optional. Defaults:
 #' * n <- seq(from = 5, to = 2000, by = 5)
@@ -17,6 +17,7 @@
 #' @param type string of value "two.sample", "one.sample", or "paired"
 #' @param save_path string inidicating where the function output should be saved
 #' @return list of calculated powCalc objects
+#' @seealso \code{\link{calc_prop}}
 #' @export
 #'
 calc_t <- function(n, theta, xi, alpha, type, save_path){

R/fun_calc_t.R

@@ -1,7 +1,7 @@
 #' Shinydashboard two-color custom mint header
 #'
 #' @param header_title string containing a header title
-#' @return shiny.tag list with a custom header with title as defined in header_title
+#' @return shiny.tag list with a custom header
 #' @export
 #'
 get_header_mint <- function(header_title){

R/fun_get_header_mint.R

@@ -1,15 +1,15 @@
-#' Retrieves a list of module names
+#' Retrieves a list of module aliases
 #'
-#' These names will be used to define module IDs in shiny::callModule(),
-#' and also as tabnames for the sidebar, and shiny UI function label and id.
+#' Module aliases retrieved via get_module_registry() are used to define module IDs in shiny::callModule(),
+#' and are also used as tabnames for the sidebar, and shiny UI function, label and id.
 #'
-#' @return list of strings containing names of
+#' @return list of strings containing module aliases
 #' @seealso \code{\link{app_ui}}, \code{\link{app_server}}
 #' @export
 #'
 get_module_registry <- function(){
   mod <- list()
-  mod$app_intro <- "app_intro"
+  mod$sse_intro <- "sse_intro"
   mod$sse_ttest <- "sse_ttest"
   mod$sse_ttest_plus <- "sse_ttest_plus"
   mod$sse_prop <- "sse_prop"

R/fun_get_module_registry.R

@@ -0,0 +1,12 @@
+#' Launches the shinysse Shiny web app
+#'
+#' You can run the web application by calling the run_shiny() function.
+#'
+#' @seealso \code{\link{app_server}}, \code{\link{app_ui}}
+#' @export
+#'
+run_shiny <- function(){
+    ## make resources available globally from non standard location
+    addResourcePath("www", system.file("www", package = "shinysse"))
+    shiny_app <- shinyApp(ui = app_ui, server = app_server)
+}

R/fun_run_shiny.R

@@ -0,0 +1,7 @@
+#' Shiny module server function for the app introduction page
+#'
+#' @seealso \code{\link{sse_intro_ui}}
+#'
+sse_intro <- function(input, output, session) {
+
+}