Skip to content

Commit fa56167

Browse files
committed
fix meta data and regenerate docs
1 parent 762641f commit fa56167

File tree

7 files changed

+54
-5
lines changed

7 files changed

+54
-5
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Maintainer: Samuel Gratzl <[email protected]>
99
URL: https://github.com/datavisyn/lineup_htmlwidget/
1010
BugReports: https://github.com/datavisyn/lineup_htmlwidget/issues
1111
Depends: R (>= 3.2.0)
12-
License: MIT
12+
License: MIT + file LICENSE
1313
Encoding: UTF-8
1414
Imports:
1515
htmlwidgets,

NAMESPACE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ export(lineupRanking)
66
export(renderLineup)
77
export(renderTaggle)
88
export(taggle)
9+
export(taggleOutput)

R/lineup.R

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,10 @@
113113
#' @return html lineup widget
114114
#'
115115
#' @examples
116+
#' \dontrun{
116117
#' lineup(mtcars)
117118
#' lineup(iris)
119+
#' }
118120
#'
119121
#' @export
120122
lineup = function(data,
@@ -164,8 +166,10 @@ lineup = function(data,
164166
#' @return html taggle widget
165167
#'
166168
#' @examples
169+
#' \dontrun{
167170
#' taggle(mtcars)
168171
#' taggle(iris)
172+
#' }
169173
#'
170174
#' @export
171175
taggle = function(data,
@@ -220,7 +224,8 @@ taggle = function(data,
220224
#' @examples
221225
#' lineupRanking(columns=c('*'))
222226
#' lineupRanking(columns=c('*'), sortBy = c('hp'))
223-
#' lineupRanking(columns=c('*', 'sum'), sum = list(type='weightedSum', columns = c('hp', 'wt'), weights = c(0.7, 0.3)))
227+
#' lineupRanking(columns=c('*', 'sum'),
228+
#' sum = list(type='weightedSum', columns = c('hp', 'wt'), weights = c(0.7, 0.3)))
224229
#'
225230
#' @export
226231
lineupRanking = function(columns = c('_*', '*'),
@@ -272,6 +277,23 @@ renderLineup = function(expr,
272277
htmlwidgets::shinyRenderWidget(expr, lineupOutput, env, quoted = TRUE)
273278
}
274279

280+
#' Shiny bindings for taggle
281+
#'
282+
#' Output and render functions for using taggle within Shiny
283+
#' applications and interactive Rmd documents.
284+
#'
285+
#' @param outputId output variable to read from
286+
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
287+
#' \code{'800px'}, \code{'auto'}) or a number, which will be coerced to a
288+
#' string and have \code{'px'} appended.
289+
#' @param expr An expression that generates a taggle
290+
#' @param env The environment in which to evaluate \code{expr}.
291+
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
292+
#' is useful if you want to save an expression in a variable.
293+
#'
294+
#' @name taggle-shiny
295+
#'
296+
#' @export
275297
taggleOutput = function(outputId,
276298
width = '100%',
277299
height = '800px') {

man/lineup.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/lineupRanking.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/taggle-shiny.Rd

Lines changed: 23 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/taggle.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)