updated docs

R/correlations-module.R

@@ -6,7 +6,7 @@
 #' @returns Shiny ui module
 #' @export
 data_correlations_ui <- function(id, ...) {
-  ns <- NS(id)
+  ns <- shiny::NS(id)
 
   shiny::tagList(
     shiny::textOutput(outputId = ns("suggest")),

R/regression_model.R

@@ -13,6 +13,7 @@
 #'
 #' @return object of standard class for fun
 #' @export
+#' @rdname regression_model
 #'
 #' @examples
 #' gtsummary::trial |>
@@ -149,6 +150,7 @@ regression_model <- function(data,
 #' @param ... ignored for now
 #'
 #' @importFrom stats as.formula
+#' @rdname regression_model
 #'
 #' @return object of standard class for fun
 #' @export
@@ -323,7 +325,7 @@ supported_functions <- function() {
 #'
 #' @param data data
 #'
-#' @returns
+#' @returns character vector
 #' @export
 #'
 #' @examples
@@ -412,8 +414,9 @@ get_fun_options <- function(data) {
 #' argsstring2list() or list of arguments. Default is NULL.
 #' @param ... ignored
 #'
-#' @returns
+#' @returns list
 #' @export
+#' @rdname regression_model
 #'
 #' @examples
 #' \dontrun{
@@ -528,19 +531,9 @@ list2str <- function(data) {
 }
 
 
-#' Title
-#'
-#' @param data
-#' @param outcome.str
-#' @param fun.descr
-#' @param fun
-#' @param formula.str
-#' @param args.list
-#' @param vars
-#' @param ...
-#'
 #' @returns list
 #' @export
+#' @rdname regression_model
 #'
 #' @examples
 #' \dontrun{

R/shiny_freesearcheR.R

@@ -23,3 +23,15 @@ shiny_freesearcheR <- function(...) {
   a <- shiny::runApp(appDir = paste0(appDir,"/app.R"), ...)
   return(invisible(a))
 }
+
+
+#' Easily launch the freesearcheR app
+#'
+#' @param ... passed on to `shiny::runApp()`
+#'
+#' @returns shiny app
+#' @export
+#'
+launch <- function(...){
+  shiny_freesearcheR(...)
+}