build: fix check errors

Author: sgratzl

.Rbuildignore

@@ -13,5 +13,6 @@ node_modules
 ^\.bumpversion\.cfg$
 ^\.editorconfig$
 ^\.lintr$
+^docs$
 ^Makefile$
 ^CRAN-SUBMISSION$

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
 Version: 4.3.0
-Date: 2022-07-28 01:13:21 UTC
-SHA: 183d4c30dd7a561518ae8093b89c4c156269fe6a
+Date: 2022-08-09 23:53:33 UTC
+SHA: 0f23d26d63db1792f4867a5989db48db1fc45e3a

DESCRIPTION

@@ -4,9 +4,9 @@ Title: 'HTMLWidget' Wrapper of 'LineUp' for Visual Analysis of Multi-Attribute R
 Description: 'LineUp' is an interactive technique designed to create, visualize and explore rankings of items based on a set of heterogeneous attributes.
   This is a 'htmlwidget' wrapper around the JavaScript library 'LineUp.js'.
   It is designed to be used in 'R Shiny' apps and 'R Markddown' files.
-  Due to an outdated 'webkit' version of 'RStudio' it won't work in the intergrated viewer.
-Version: 4.3.0
-Date: 2021-08-30
+  Due to an outdated 'webkit' version of 'RStudio' it won't work in the integrated viewer.
+Version: 4.6.0
+Date: 2022-08-10
 Authors@R: person("Samuel", "Gratzl", email = "[email protected]", role = c("aut", "cre"))
 Maintainer: Samuel Gratzl <[email protected]>
 URL: https://github.com/lineupjs/lineup_htmlwidget/
@@ -25,7 +25,6 @@ Suggests:
   lintr,
   remotes,
   styler
-LazyData: true
 RoxygenNote: 7.2.0
 VignetteBuilder: knitr
 Language: en-US

NAMESPACE

@@ -10,5 +10,3 @@ export(renderLineup)
 export(renderTaggle)
 export(taggle)
 export(taggleOutput)
-importFrom(htmlwidgets,shinyRenderWidget)
-importFrom(htmlwidgets,shinyWidgetOutput)

R/lineup.R

@@ -16,7 +16,8 @@
   defaultSlopeGraphMode = "item",
   ignoreUnsupportedBrowser = FALSE
 )
-#' taggle - factory for Taggle HTMLWidget
+
+#' lineup builder pattern function
 #'
 #' @param data data frame like object i.e. also crosstalk shared data frame
 #' @param options LineUp options
@@ -47,8 +48,7 @@
 #'
 #' @examples
 #' \dontrun{
-#' taggle(mtcars)
-#' taggle(iris)
+#' lineupBuilder(iris) |> buildLineUp()
 #' }
 #'
 #' @export
@@ -130,7 +130,7 @@ lineupBuilder <- function(data,
   }
 }
 
-#' lineup - factory for LineUp HTMLWidget
+#' factory for LineUp HTMLWidget based on a LineUpBuilder
 #'
 #' @param x LineUpBuilder object
 #' @param width width of the element
@@ -140,6 +140,10 @@ lineupBuilder <- function(data,
 #'
 #' @return html lineup widget
 #'
+#' @examples
+#' \dontrun{
+#' lineupBuilder(iris) |> buildLineUp()
+#' }
 #' @export
 buildLineUp <- function(x, width = "100%",
                         height = NULL,
@@ -148,16 +152,13 @@ buildLineUp <- function(x, width = "100%",
   .buildLineUpWidget(x, width, height, elementId, dependencies, lineupType = "lineup")
 }
 
-#' taggle - factory for Taggle HTMLWidget
+#' factory for LineUp HTMLWidget based on a LineUpBuilder
+#' @inheritParams buildLineUp
 #'
-#' @param x LineUpBuilder object
-#' @param width width of the element
-#' @param height height of the element
-#' @param elementId unique element id
-#' @param dependencies include crosstalk dependencies
-#'
-#' @return html taggle widget
-
+#' @examples
+#' \dontrun{
+#' lineupBuilder(iris) |> buildTaggle()
+#' }
 #' @export
 buildTaggle <- function(x, width = "100%",
                         height = NULL,
@@ -169,40 +170,18 @@ buildTaggle <- function(x, width = "100%",
 
 #' lineup - factory for LineUp HTMLWidget
 #'
-#' @param data data frame like object i.e. also crosstalk shared data frame
+#' @inheritParams lineupBuilder
+#' @inheritDotParams lineupBuilder
 #' @param width width of the element
 #' @param height height of the element
 #' @param elementId unique element id
-#' @param options LineUp options
-#' @param ranking ranking definition created using \code{\link{lineupRanking}}
 #' @param dependencies include crosstalk dependencies
-#' @param ... additional ranking definitions like 'ranking1=...' due to restrictions in converting parameters
-#'
-#' @section LineUp options:
-#'   \describe{
-#'    \item{filterGlobally}{whether filter within one ranking applies to all rankings (default: TRUE)}
-#'    \item{singleSelection}{restrict to single item selection (default: FALSE}
-#'    \item{noCriteriaLimits}{allow more than one sort and grouping criteria (default: FALSE)}
-#'    \item{animated}{use animated transitions (default: TRUE)}
-#'    \item{sidePanel}{show side panel (TRUE, FALSE, 'collapsed') (default: 'collapsed')}
-#'    \item{hierarchyIndicator}{show sorting and grouping hierarchy indicator (TRUE, FALSE) (default: TRUE)}
-#'    \item{labelRotation}{how many degrees should a label be rotated in case of narrow columns (default: 0)}
-#'    \item{summaryHeader}{show summary histograms in the header (default: TRUE)}
-#'    \item{overviewMode}{show overview mode in Taggle by default (default: FALSE)}
-#'    \item{expandLineOnHover}{expand to full row height on mouse over (default: FALSE)}
-#'    \item{defaultSlopeGraphMode}{default slope graph mode: item,band (default: 'item')}
-#'    \item{ignoreUnsupportedBrowser}{ignore unsupported browser detection at own risk (default: FALSE)}
-#'    \item{rowHeight}{height of a row in pixel (default: 18)}
-#'    \item{rowPadding}{padding between two rows in pixel  (default: 2)}
-#'    \item{groupHeight}{height of an aggregated group in pixel (default: 40)}
-#'    \item{groupPadding}{padding between two groups in pixel (default: 5)}
-#'  }
 #'
+#' @inheritSection lineupBuilder LineUp options
 #' @return html lineup widget
 #'
 #' @examples
 #' \dontrun{
-#' lineup(mtcars)
 #' lineup(iris)
 #' }
 #'
@@ -222,40 +201,14 @@ lineup <- function(data,
 
 #' taggle - factory for Taggle HTMLWidget
 #'
-#' @param data data frame like object i.e. also crosstalk shared data frame
-#' @param width width of the element
-#' @param height height of the element
-#' @param elementId unique element id
-#' @param options LineUp options
-#' @param ranking ranking definition created using \code{\link{lineupRanking}}
-#' @param dependencies include crosstalk dependencies
-#' @param ... additional ranking definitions like 'ranking1=...' due to restrictions in converting parameters
-#'
-#' @section LineUp options:
-#' \describe{
-#'  \item{filterGlobally}{whether filter within one ranking applies to all rankings (default: TRUE)}
-#'  \item{singleSelection}{restrict to single item selection (default: FALSE}
-#'  \item{noCriteriaLimits}{allow more than one sort and grouping criteria (default: FALSE)}
-#'  \item{animated}{use animated transitions (default: TRUE)}
-#'  \item{sidePanel}{show side panel (TRUE, FALSE, 'collapsed') (default: 'collapsed')}
-#'  \item{hierarchyIndicator}{show sorting and grouping hierarchy indicator (TRUE, FALSE) (default: TRUE)}
-#'  \item{labelRotation}{how many degrees should a label be rotated in case of narrow columns (default: 0)}
-#'  \item{summaryHeader}{show summary histograms in the header (default: TRUE)}
-#'  \item{overviewMode}{show overview mode in Taggle by default (default: FALSE)}
-#'  \item{expandLineOnHover}{expand to full row height on mouse over (default: FALSE)}
-#'  \item{defaultSlopeGraphMode}{default slope graph mode: item,band (default: 'item')}
-#'  \item{ignoreUnsupportedBrowser}{ignore unsupported browser detection at own risk (default: FALSE)}
-#'  \item{rowHeight}{height of a row in pixel (default: 18)}
-#'  \item{rowPadding}{padding between two rows in pixel  (default: 2)}
-#'  \item{groupHeight}{height of an aggregated group in pixel (default: 40)}
-#'  \item{groupPadding}{padding between two groups in pixel (default: 5)}
-#' }
+#' @inheritParams lineup
+#' @inheritDotParams lineup
+#' @inheritSection lineup LineUp options
 #'
 #' @return html taggle widget
 #'
 #' @examples
 #' \dontrun{
-#' taggle(mtcars)
 #' taggle(iris)
 #' }
 #'
@@ -334,13 +287,6 @@ lineupRanking <- function(columns = c("_*", "*"),
 #' @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 lineup
-#' @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 lineup-shiny#'
-#' @importFrom htmlwidgets shinyWidgetOutput
 #'
 #' @export
 lineupOutput <- function(outputId,
@@ -351,7 +297,6 @@ lineupOutput <- function(outputId,
 
 #' Shiny render bindings for lineup
 #'
-#' @rdname lineup-shiny
 #' @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
@@ -371,17 +316,8 @@ renderLineup <- function(expr,
 #' 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.
+#' @inheritParams lineupOutput
 #'
-#' @name taggle-shiny
-#' @importFrom htmlwidgets shinyWidgetOutput
 #'
 #' @export
 taggleOutput <- function(outputId,
@@ -392,8 +328,8 @@ taggleOutput <- function(outputId,
 
 #' Shiny render bindings for taggle
 #'
-#' @importFrom htmlwidgets shinyRenderWidget
-#' @rdname taggle-shiny
+#' @inheritParams renderLineup
+#'
 #' @export
 renderTaggle <- function(expr,
                          env = parent.frame(),

README.md

@@ -4,9 +4,9 @@ LineUp.js as HTMLWidget
 [![License: MIT][mit-image]][mit-url] [![Github Actions][github-actions-image]][github-actions-url]
 
 LineUp is an interactive technique designed to create, visualize and explore rankings of items based on a set of heterogeneous attributes.
-This is a [HTMLWidget](http://www.htmlwidgets.org/) wrapper around the JavaScript library [LineUp.js](https://github.com/lineupjs/lineupjs). Details about the LineUp visualization technique can be found at [http://lineup.caleydo.org](http://lineup.caleydo.org).
+This is a [HTMLWidget](http://www.htmlwidgets.org/) wrapper around the JavaScript library [LineUp.js](https://github.com/lineupjs/lineupjs). Details about the LineUp visualization technique can be found at [ https://jku-vds-lab.at/tools/lineup/](https://jku-vds-lab.at/tools/lineup/).
 
-It can be used within standalone [R Shiny](https://shiny.rstudio.com/) apps or [R Markdown](http://rmarkdown.rstudio.com/) files. **Integrated plotting does not work due to an outdated integrated Webkit version in RStudio**.
+It can be used within standalone [R Shiny](https://shiny.rstudio.com/) apps or [R Markdown](https://rmarkdown.rstudio.com/) files.
 [Crosstalk](https://rstudio.github.io/crosstalk/) is supported for synching selections and filtering among widgets.
 
 Installation

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "lineup_htmlwidget",
-  "version": "4.2.0",
+  "version": "4.6.0",
   "description": "LineUp.js as HTMLWidget",
   "bugs": {
     "url": "https://github.com/lineupjs/lineup_htmlwidget/issues"