From 6c12978e59ab7a7febf9020bf95e504d13420bef Mon Sep 17 00:00:00 2001
From: pvictor <victor.perrier@dreamRs.fr>
Date: Wed, 26 Jun 2024 10:53:55 +0200
Subject: [PATCH] updated docs

---
 R/search-vars.R              | 32 ++++++++++++++------------------
 man/adminlte_color.Rd        |  2 +-
 man/adminlte_global.Rd       |  2 +-
 man/adminlte_sidebar.Rd      |  2 +-
 man/adminlte_vars.Rd         |  2 +-
 man/search_vars_adminlte2.Rd | 10 +++++-----
 man/search_vars_bs.Rd        |  6 +++---
 man/search_vars_bs4dash.Rd   |  8 ++++----
 8 files changed, 30 insertions(+), 34 deletions(-)

diff --git a/R/search-vars.R b/R/search-vars.R
index efe75ca..3a2e1ad 100644
--- 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
index 68bad3e..25ed581 100644
--- a/man/adminlte_color.Rd
+++ b/man/adminlte_color.Rd
@@ -61,7 +61,7 @@ a \code{list} that can be used in \code{\link{create_theme}}.
 }
 \description{
 Those variables can be used to customize
-defaults colors in {shinydashboard}.
+defaults colors in shinydashboard.
 }
 \examples{
 
diff --git a/man/adminlte_global.Rd b/man/adminlte_global.Rd
index 050d052..87e813d 100644
--- a/man/adminlte_global.Rd
+++ b/man/adminlte_global.Rd
@@ -18,7 +18,7 @@ a \code{list} that can be used in \code{\link{create_theme}}.
 }
 \description{
 Those variables can be used to customize
-global settings in {shinydashboard}.
+global settings in shinydashboard.
 }
 \examples{
 if (interactive()) {
diff --git a/man/adminlte_sidebar.Rd b/man/adminlte_sidebar.Rd
index 72950d4..7bc1e9d 100644
--- a/man/adminlte_sidebar.Rd
+++ b/man/adminlte_sidebar.Rd
@@ -58,7 +58,7 @@ a \code{list} that can be used in \code{\link{create_theme}}.
 }
 \description{
 Those variables can be used to customize
-the sidebar in {shinydashboard}.
+the sidebar in shinydashboard.
 }
 \examples{
 if (interactive()) {
diff --git a/man/adminlte_vars.Rd b/man/adminlte_vars.Rd
index cc5c7d0..047c20f 100644
--- a/man/adminlte_vars.Rd
+++ b/man/adminlte_vars.Rd
@@ -13,7 +13,7 @@ adminlte_vars(...)
 a \code{list} that can be used in \code{\link{create_theme}}.
 }
 \description{
-Use any AdminLTE or Bootstrap variables to customize a \{shinydashboard\} theme.
+Use any AdminLTE or Bootstrap variables to customize a shinydashboard theme.
 }
 \note{
 For a full list of available variables, use \code{\link{search_vars_adminlte2}}.
diff --git a/man/search_vars_adminlte2.Rd b/man/search_vars_adminlte2.Rd
index 7a38222..7687202 100644
--- a/man/search_vars_adminlte2.Rd
+++ b/man/search_vars_adminlte2.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/search-vars.R
 \name{search_vars_adminlte2}
 \alias{search_vars_adminlte2}
-\title{Search AdminLTE 2 (shinydashboard) variables}
+\title{Search AdminLTE 2 shinydashboard variables}
 \usage{
 search_vars_adminlte2(pattern = NULL)
 }
@@ -10,14 +10,14 @@ search_vars_adminlte2(pattern = NULL)
 \item{pattern}{A pattern to filter the results.}
 }
 \value{
-a \code{data.frame} with two variables:
+a \code{data.frame} with two columns:
 \itemize{
-\item{\code{variable}: }{name of the variable.}
-\item{\code{value}: }{default value used in theme.}
+\item \code{variable} : name of the variable.
+\item \code{value} default value used.
 }
 }
 \description{
-Search AdminLTE 2 (shinydashboard) variables
+Search AdminLTE 2 shinydashboard variables
 }
 \examples{
 # All AdminLTE2 variables
diff --git a/man/search_vars_bs.Rd b/man/search_vars_bs.Rd
index 40d8f21..cdb8c84 100644
--- a/man/search_vars_bs.Rd
+++ b/man/search_vars_bs.Rd
@@ -17,10 +17,10 @@ search_vars_bs(
 \item{theme}{Name of the theme for which to search the variables.}
 }
 \value{
-a \code{data.frame} with two variables:
+a \code{data.frame} with two columns:
 \itemize{
-\item{\code{variable}: }{name of the variable.}
-\item{\code{value}: }{default value used in theme.}
+\item \code{variable} : name of the variable.
+\item \code{value} default value used.
 }
 }
 \description{
diff --git a/man/search_vars_bs4dash.Rd b/man/search_vars_bs4dash.Rd
index 5e593f5..c823ee1 100644
--- a/man/search_vars_bs4dash.Rd
+++ b/man/search_vars_bs4dash.Rd
@@ -12,11 +12,11 @@ search_vars_bs4dash(pattern = NULL, source = c("adminlte", "bootstrap"))
 \item{source}{Search variables in AdminLTE or Bootstrap or both.}
 }
 \value{
-a \code{data.frame} with three variables:
+a \code{data.frame} with three columns:
 \itemize{
-\item{\code{source}: }{AdminLTE or Bootstrap variable.}
-\item{\code{variable}: }{name of the variable.}
-\item{\code{value}: }{default value used.}
+\item \code{source} : AdminLTE or Bootstrap variable.
+\item \code{variable} : name of the variable.
+\item \code{value} default value used.
 }
 }
 \description{