update documentation

R/actionBttn.R

@@ -1,6 +1,6 @@
 #' @title Awesome action button
 #'
-#' @description Like actionButton but awesome, via \url{https://bttn.surge.sh/}
+#' @description Like \code{actionButton} but awesome, via \url{https://bttn.surge.sh/}
 #'
 #' @param inputId The \code{input} slot that will be used to access the value.
 #' @param label The contents of the button, usually a text label.
@@ -90,7 +90,7 @@ actionBttn <- function(inputId, label = NULL, icon = NULL, style = "unite",
 
 
 
-#' Create a download bttn
+#' Create a download \code{\link{actionBttn}}
 #'
 #' Create a download button with \link{actionBttn}.
 #'

R/chooseSliderSkin.R

@@ -1,6 +1,6 @@
-#' @title Theme selector for sliderInput
+#' @title Theme selector for \code{sliderInput}
 #'
-#' @description Customize the appearance of the original shiny's sliderInputs
+#' @description Customize the appearance of the original shiny's \code{sliderInput}
 #'
 #' @param skin The \code{skin} to apply. Choose among 5 different flavors,
 #'  namely 'Shiny', 'Flat', 'Modern', 'Nice', 'Simple', 'HTML5', 'Round' and 'Square'.

R/input-airDatepicker.R

@@ -40,7 +40,7 @@
 #' @param width The width of the input, e.g. \code{'400px'}, or \code{'100\%'}.
 #' @param ... Arguments passed to \code{airDatepickerInput}.
 #'
-#' @note This widget prevents `dateInput` from working, don't use both !
+#' @note This widget prevents \code{dateInput} from working, don't use both !
 #'
 #' @return a \code{Date} object or a \code{POSIXct} in UTC timezone.
 #'
@@ -274,7 +274,7 @@ airYearpickerInput <- function(inputId, label = NULL, value = NULL, ...) {
 
 
 
-#' Change the value of a airDate input on the client
+#' Change the value of \code{\link{airDatepickerInput}} on the client
 #'
 #' @param session The \code{session} object passed to function given to \code{shinyServer}.
 #' @param inputId The id of the input object.

R/input-awesomecheckbox.R

@@ -171,10 +171,10 @@ awesomeCheckboxGroup <- function (inputId, label, choices, selected = NULL, inli
 
 
 
-#' @title Change the value of a AwesomeCheckboxGroup input on the client
+#' @title Change the value of a \code{\link{awesomeCheckboxGroup}} input on the client
 #'
 #' @description
-#' Change the value of a AwesomeCheckboxGroup input on the client
+#' Change the value of a \code{\link{awesomeCheckboxGroup}} input on the client
 #'
 #'
 #' @param session The session object passed to function given to shinyServer.

R/input-colorselector.R

@@ -6,18 +6,16 @@
 #' @param label Display label for the control, or \code{NULL} for no label.
 #' @param choices A list of colors, can be a list of named list, see example.
 #' @param selected Default selected color, if \code{NULL} the first color for \code{mode = 'radio'}
-#' and none for \code{mode = 'checkbox'}
+#'  and none for \code{mode = 'checkbox'}
 #' @param mode \code{'radio'} for only one choice, \code{'checkbox'} for
-#' selecting multiple values.
+#'  selecting multiple values.
 #' @param display_label Display list's names after palette of color.
 #' @param ncol If choices is not a list but a vector, go to line after n elements.
 #'
-#' @return a colorSelectorInput control
 #' @importFrom htmltools tags tagList
 #' @export
 #'
 #' @examples
-#' \dontrun{
 #' if (interactive()) {
 #'
 #' # Full example
@@ -43,7 +41,6 @@
 #' shinyApp(ui = ui, server = server)
 #'
 #' }
-#' }
 colorSelectorInput <- function(inputId, label, choices, selected = NULL, mode = c("radio", "checkbox"), display_label = FALSE, ncol = 10) {
   selected <- shiny::restoreInput(id = inputId, default = selected)
   mode <- match.arg(arg = mode)

R/module-pickerGroup.R

@@ -1,10 +1,10 @@
 
 #' @title Picker Group
 #'
-#' @description Group of mutually dependent `pickerInput` for filtering \code{data.frame}'s columns.
+#' @description Group of mutually dependent \code{\link{pickerInput}} for filtering \code{data.frame}'s columns.
 #'
 #' @param id Module's id.
-#' @param params A named list of parameters passed to each `pickerInput`, you can use :
+#' @param params A named list of parameters passed to each \code{\link{pickerInput}}, you can use :
 #'  `inputId` (obligatory, must be variable name), `label`, `placeholder`.
 #' @param label Character, global label on top of all labels.
 #' @param btn_label Character, reset button label.