Skip to content

Commit

Permalink
fix meta data and regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sgratzl committed Jun 27, 2018
1 parent 762641f commit fa56167
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Maintainer: Samuel Gratzl <samuel.gratzl@datavisyn.io>
URL: https://github.com/datavisyn/lineup_htmlwidget/
BugReports: https://github.com/datavisyn/lineup_htmlwidget/issues
Depends: R (>= 3.2.0)
License: MIT
License: MIT + file LICENSE
Encoding: UTF-8
Imports:
htmlwidgets,
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ export(lineupRanking)
export(renderLineup)
export(renderTaggle)
export(taggle)
export(taggleOutput)
24 changes: 23 additions & 1 deletion R/lineup.R
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@
#' @return html lineup widget
#'
#' @examples
#' \dontrun{
#' lineup(mtcars)
#' lineup(iris)
#' }
#'
#' @export
lineup = function(data,
Expand Down Expand Up @@ -164,8 +166,10 @@ lineup = function(data,
#' @return html taggle widget
#'
#' @examples
#' \dontrun{
#' taggle(mtcars)
#' taggle(iris)
#' }
#'
#' @export
taggle = function(data,
Expand Down Expand Up @@ -220,7 +224,8 @@ taggle = function(data,
#' @examples
#' lineupRanking(columns=c('*'))
#' lineupRanking(columns=c('*'), sortBy = c('hp'))
#' lineupRanking(columns=c('*', 'sum'), sum = list(type='weightedSum', columns = c('hp', 'wt'), weights = c(0.7, 0.3)))
#' lineupRanking(columns=c('*', 'sum'),
#' sum = list(type='weightedSum', columns = c('hp', 'wt'), weights = c(0.7, 0.3)))
#'
#' @export
lineupRanking = function(columns = c('_*', '*'),
Expand Down Expand Up @@ -272,6 +277,23 @@ renderLineup = function(expr,
htmlwidgets::shinyRenderWidget(expr, lineupOutput, env, quoted = TRUE)
}

#' Shiny bindings for taggle
#'
#' Output and render functions for using taggle within Shiny
#' applications and interactive Rmd documents.
#'
#' @param outputId output variable to read from
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
#' \code{'800px'}, \code{'auto'}) or a number, which will be coerced to a
#' string and have \code{'px'} appended.
#' @param expr An expression that generates a taggle
#' @param env The environment in which to evaluate \code{expr}.
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
#' is useful if you want to save an expression in a variable.
#'
#' @name taggle-shiny
#'
#' @export
taggleOutput = function(outputId,
width = '100%',
height = '800px') {
Expand Down
2 changes: 2 additions & 0 deletions man/lineup.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/lineupRanking.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 23 additions & 2 deletions man/taggle-shiny.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/taggle.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fa56167

Please sign in to comment.