Skip to content

Commit 52053aa

Browse files
committed
docs: add missing return values
1 parent 02286e2 commit 52053aa

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

R/lineup.R

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
#' \item{groupPadding}{padding between two groups in pixel (default: 5)}
4545
#' }
4646
#'
47-
#' @return lineup builder objects
47+
#' @return lineup builder object
4848
#'
4949
#' @examples
5050
#' \dontrun{
@@ -138,7 +138,7 @@ lineupBuilder <- function(data,
138138
#' @param elementId unique element id
139139
#' @param dependencies include crosstalk dependencies
140140
#'
141-
#' @return html lineup widget
141+
#' @return lineup html widget
142142
#'
143143
#' @examples
144144
#' \dontrun{
@@ -155,6 +155,8 @@ buildLineUp <- function(x, width = "100%",
155155
#' factory for LineUp HTMLWidget based on a LineUpBuilder
156156
#' @inheritParams buildLineUp
157157
#'
158+
#' @return taggle html widget
159+
#'
158160
#' @examples
159161
#' \dontrun{
160162
#' lineupBuilder(iris) |> buildTaggle()
@@ -178,7 +180,7 @@ buildTaggle <- function(x, width = "100%",
178180
#' @param ... additional ranking definitions like 'ranking1=...' due to restrictions in converting parameters
179181
#'
180182
#' @inheritSection lineupBuilder LineUp options
181-
#' @return html lineup widget
183+
#' @return lineup html widget
182184
#'
183185
#' @examples
184186
#' \dontrun{
@@ -205,7 +207,7 @@ lineup <- function(data,
205207
#' @param ... additional ranking definitions like 'ranking1=...' due to restrictions in converting parameters
206208
#' @inheritSection lineup LineUp options
207209
#'
208-
#' @return html taggle widget
210+
#' @return taggle html widget
209211
#'
210212
#' @examples
211213
#' \dontrun{
@@ -288,6 +290,7 @@ lineupRanking <- function(columns = c("_*", "*"),
288290
#' \code{'800px'}, \code{'auto'}) or a number, which will be coerced to a
289291
#' string and have \code{'px'} appended.
290292
#' @rdname lineup-shiny
293+
#' @return An output or render function that enables the use of the widget within Shiny applications.
291294
#' @examples # !formatR
292295
#' library(shiny)
293296
#' app <- shinyApp(
@@ -322,7 +325,7 @@ renderLineup <- function(expr,
322325
if (!quoted) {
323326
expr <- substitute(expr)
324327
} # force quoted
325-
htmlwidgets::shinyRenderWidget(expr, lineupOutput, env, quoted = TRUE)
328+
htmlwidgets::jj(expr, lineupOutput, env, quoted = TRUE)
326329
}
327330

328331
#' Shiny bindings for taggle
@@ -332,6 +335,7 @@ renderLineup <- function(expr,
332335
#'
333336
#' @inheritParams lineupOutput
334337
#' @rdname taggle-shiny
338+
#' @return An output or render function that enables the use of the widget within Shiny applications.
335339
#' @examples # !formatR
336340
#' library(shiny)
337341
#' app <- shinyApp(

0 commit comments

Comments
 (0)