From 36b5439687e9b7fd9430d50692ab2a0d51f1db56 Mon Sep 17 00:00:00 2001 From: Samuel Gratzl Date: Mon, 15 Jun 2020 13:49:07 +0200 Subject: [PATCH] update man pages --- DESCRIPTION | 2 +- man/buildLineUp.Rd | 9 +++++++-- man/buildTaggle.Rd | 9 +++++++-- man/dot-lineupDefaultOptions.Rd | 2 +- man/lineup.Rd | 14 ++++++++++---- man/lineupBuilder.Rd | 4 +--- man/lineupRanking.Rd | 3 +-- man/taggle.Rd | 13 ++++++++++--- 8 files changed, 38 insertions(+), 18 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b2b8df6..90b4939 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -19,4 +19,4 @@ Imports: htmltools, crosstalk LazyData: true -RoxygenNote: 6.1.1 +RoxygenNote: 7.0.2 diff --git a/man/buildLineUp.Rd b/man/buildLineUp.Rd index 650b6c7..9800290 100644 --- a/man/buildLineUp.Rd +++ b/man/buildLineUp.Rd @@ -4,8 +4,13 @@ \alias{buildLineUp} \title{lineup - factory for LineUp HTMLWidget} \usage{ -buildLineUp(x, width = "100\%", height = NULL, elementId = NULL, - dependencies = crosstalk::crosstalkLibs()) +buildLineUp( + x, + width = "100\%", + height = NULL, + elementId = NULL, + dependencies = crosstalk::crosstalkLibs() +) } \arguments{ \item{x}{LineUpBuilder object} diff --git a/man/buildTaggle.Rd b/man/buildTaggle.Rd index 0e86112..a4b582f 100644 --- a/man/buildTaggle.Rd +++ b/man/buildTaggle.Rd @@ -4,8 +4,13 @@ \alias{buildTaggle} \title{taggle - factory for Taggle HTMLWidget} \usage{ -buildTaggle(x, width = "100\%", height = NULL, elementId = NULL, - dependencies = crosstalk::crosstalkLibs()) +buildTaggle( + x, + width = "100\%", + height = NULL, + elementId = NULL, + dependencies = crosstalk::crosstalkLibs() +) } \arguments{ \item{x}{LineUpBuilder object} diff --git a/man/dot-lineupDefaultOptions.Rd b/man/dot-lineupDefaultOptions.Rd index 519f815..c9f564f 100644 --- a/man/dot-lineupDefaultOptions.Rd +++ b/man/dot-lineupDefaultOptions.Rd @@ -4,7 +4,7 @@ \name{.lineupDefaultOptions} \alias{.lineupDefaultOptions} \title{LineUpjs module} -\format{An object of class \code{list} of length 16.} +\format{An object of class \code{list} of length 15.} \usage{ .lineupDefaultOptions } diff --git a/man/lineup.Rd b/man/lineup.Rd index 6af5711..7ef978f 100644 --- a/man/lineup.Rd +++ b/man/lineup.Rd @@ -4,9 +4,16 @@ \alias{lineup} \title{lineup - factory for LineUp HTMLWidget} \usage{ -lineup(data, width = "100\%", height = NULL, elementId = NULL, - options = c(.lineupDefaultOptions), ranking = NULL, - dependencies = crosstalk::crosstalkLibs(), ...) +lineup( + data, + width = "100\%", + height = NULL, + elementId = NULL, + options = c(.lineupDefaultOptions), + ranking = NULL, + dependencies = crosstalk::crosstalkLibs(), + ... +) } \arguments{ \item{data}{data frame like object i.e. also crosstalk shared data frame} @@ -21,7 +28,6 @@ lineup(data, width = "100\%", height = NULL, elementId = NULL, \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)} diff --git a/man/lineupBuilder.Rd b/man/lineupBuilder.Rd index f1bc100..078986d 100644 --- a/man/lineupBuilder.Rd +++ b/man/lineupBuilder.Rd @@ -4,8 +4,7 @@ \alias{lineupBuilder} \title{taggle - factory for Taggle HTMLWidget} \usage{ -lineupBuilder(data, options = c(.lineupDefaultOptions), ranking = NULL, - ...) +lineupBuilder(data, options = c(.lineupDefaultOptions), ranking = NULL, ...) } \arguments{ \item{data}{data frame like object i.e. also crosstalk shared data frame} @@ -14,7 +13,6 @@ lineupBuilder(data, options = c(.lineupDefaultOptions), ranking = NULL, \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)} diff --git a/man/lineupRanking.Rd b/man/lineupRanking.Rd index fd96e63..0556a14 100644 --- a/man/lineupRanking.Rd +++ b/man/lineupRanking.Rd @@ -4,8 +4,7 @@ \alias{lineupRanking} \title{helper function for creating a LineUp ranking definition as used by \code{\link{lineup}}} \usage{ -lineupRanking(columns = c("_*", "*"), sortBy = c(), groupBy = c(), - ...) +lineupRanking(columns = c("_*", "*"), sortBy = c(), groupBy = c(), ...) } \arguments{ \item{columns}{list of columns shown in this ranking, besides \emph{column names of the given data frame} following special columsn are available diff --git a/man/taggle.Rd b/man/taggle.Rd index e83611e..67f860b 100644 --- a/man/taggle.Rd +++ b/man/taggle.Rd @@ -4,9 +4,16 @@ \alias{taggle} \title{taggle - factory for Taggle HTMLWidget} \usage{ -taggle(data, width = "100\%", height = NULL, elementId = NULL, - options = c(.lineupDefaultOptions), ranking = NULL, - dependencies = crosstalk::crosstalkLibs(), ...) +taggle( + data, + width = "100\%", + height = NULL, + elementId = NULL, + options = c(.lineupDefaultOptions), + ranking = NULL, + dependencies = crosstalk::crosstalkLibs(), + ... +) } \arguments{ \item{data}{data frame like object i.e. also crosstalk shared data frame}