updated docs

dreamRs · Jun 26, 2024 · 6c12978 · 6c12978
1 parent 08fe0f8
commit 6c12978
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 34 deletions.
diff --git a/R/search-vars.R b/R/search-vars.R
@@ -3,7 +3,7 @@
 #'
 #' @param file File path in which to search for variables.
 #'
-#' @return A \code{data.frame} with 2 columns: \code{"variable"} and \code{"value"}.
+#' @return A `data.frame` with 2 columns: `"variable"` and `"value"`.
 #' @export
 #'
 #' @importFrom tools file_ext
@@ -66,12 +66,11 @@ search_vars <- function(file) {
 #' @param pattern A pattern to filter the results.
 #' @param source Search variables in AdminLTE or Bootstrap or both.
 #'
-#' @return a \code{data.frame} with three variables:
-#' \itemize{
-#'  \item{\code{source}: }{AdminLTE or Bootstrap variable.}
-#'  \item{\code{variable}: }{name of the variable.}
-#'  \item{\code{value}: }{default value used.}
-#' }
+#' @return a `data.frame` with three columns:
+#'    * `source` : AdminLTE or Bootstrap variable.
+#'    * `variable` : name of the variable.
+#'    * `value` default value used.
+#'
 #' @export
 #'
 #' @examples
@@ -112,11 +111,9 @@ search_vars_bs4dash <- function(pattern = NULL, source = c("adminlte", "bootstra
 #' @param pattern A pattern to filter the results.
 #' @param theme Name of the theme for which to search the variables.
 #'
-#' @return a \code{data.frame} with two variables:
-#' \itemize{
-#'  \item{\code{variable}: }{name of the variable.}
-#'  \item{\code{value}: }{default value used in theme.}
-#' }
+#' @return a `data.frame` with two columns:
+#'    * `variable` : name of the variable.
+#'    * `value` default value used.
 #'
 #' @export
 #'
@@ -152,15 +149,14 @@ search_vars_bs <- function(pattern = NULL,
 
 
 
-#' Search AdminLTE 2 (shinydashboard) variables
+#' Search AdminLTE 2 shinydashboard variables
 #'
 #' @param pattern A pattern to filter the results.
 #'
-#' @return a \code{data.frame} with two variables:
-#' \itemize{
-#'  \item{\code{variable}: }{name of the variable.}
-#'  \item{\code{value}: }{default value used in theme.}
-#' }
+#' @return a `data.frame` with two columns:
+#'    * `variable` : name of the variable.
+#'    * `value` default value used.
+#'    
 #' @export
 #'
 #' @examples

diff --git a/man/adminlte_color.Rd b/man/adminlte_color.Rd
diff --git a/man/adminlte_global.Rd b/man/adminlte_global.Rd
diff --git a/man/adminlte_sidebar.Rd b/man/adminlte_sidebar.Rd
diff --git a/man/adminlte_vars.Rd b/man/adminlte_vars.Rd
diff --git a/man/search_vars_adminlte2.Rd b/man/search_vars_adminlte2.Rd
diff --git a/man/search_vars_bs.Rd b/man/search_vars_bs.Rd
diff --git a/man/search_vars_bs4dash.Rd b/man/search_vars_bs4dash.Rd