#' Sanitize component names #' #' This function takes a character string, replaces spaces by underscores and runs make.names. #' #' @param x A character string. #' #' @return A sanitized string. .create_page_name <- function(x) { x %>% tolower %>% gsub(x = ., pattern = " ", replacement = "_") %>% make.names %>% return } #' Method to add a page to an i2dashboard #' #' @param dashboard A \linkS4class{i2dash::i2dashboard}. #' @param page The name of the page to be added. #' @param title The title of the page to be added. #' @param layout The page layout (see below). #' @param menu The name of the menu, under which the page should appear. #' #' @rdname i2dashboard-methods #' @export setMethod("add_page", "i2dashboard", function(dashboard, page, title, layout = "default", menu = NULL, sidebar = NULL, ...) { name <- .create_page_name(page) max_components <- switch(layout, "default" = Inf, "storyboard" = Inf, "focal_left" = 3, "2x2_grid" = 4 ) if(name %in% names(dashboard@pages)) { warning(paste("The page", name, "already exists and will be overwritten.")) if(base::interactive()) { overwrite_page <- menu(c("Yes, overwrite page", "Cancel"), title = "Do you want to overwrite this page?") skip <- switch(overwrite_page, "1" = FALSE, "2" = TRUE) if (skip) stop("Aborted.") } } dashboard@pages[[name]] <- list(title = title, layout = layout, menu = menu, components = list(), max_components = max_components, sidebar = sidebar) return(dashboard) }) #' Method to remove a page to an i2dashboard #' #' @param dashboard A \linkS4class{i2dash::i2dashboard}. #' @param page The name of the page to be removed. #' #' @rdname i2dashboard-methods #' @export setMethod("remove_page", "i2dashboard", function(dashboard, page) { name <- .create_page_name(page) dashboard@pages[[name]] <- NULL return(dashboard) })