Skip to content

Commit 782305c

Browse files
authored
Untracked: Fix documentation for build (#44)
1 parent 893f0ad commit 782305c

4 files changed

Lines changed: 23 additions & 7 deletions

File tree

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Imports:
1212
htmlwidgets
1313
Suggests:
1414
testthat
15-
RoxygenNote: 7.1.1
15+
RoxygenNote: 7.3.2

R/rhtmlSankeyTree.R

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@
1010
#' @param maxLabelLength Integer. Line wrapping will occur when the label of the node has width more than this value * 8 (pixels per char). Defaults to 25.
1111
#' @param nodeHeight Height of each node in pixels. Defaults to 100 pixels.
1212
#' @param tooltip Tooltip to attach to each node.
13+
#' @param treeColors TODO. not used. remove from callees
14+
#' @param categoryLegend TODO. not used. remove from callees
1315
#' @param terminalDescription Logical. Add description for terminal nodes? Defaults to FALSE.
1416
#' @param numeric.distribution Logical. Show numerical distribution for each node? If regression tree, then a histogram is plotted. If classification tree, then a horizontal bar plot is drawn. Defaults to TRUE.
15-
#'
16-
#'
17+
#' @param width The width of the generated widget.
18+
#' @param height The height of the generated widget.
19+
#'
20+
#'
1721
#' @import htmlwidgets
1822
#'
1923
#' @export
@@ -30,7 +34,7 @@ SankeyTree <- function(
3034
categoryLegend = FALSE, # TODO. not used. remove from callees
3135
terminalDescription = FALSE,
3236
numeric.distribution = TRUE,
33-
width = NULL,
37+
width = NULL,
3438
height = NULL) {
3539

3640
# forward options using x

man/SankeyTree.Rd

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

theSrc/R/htmlwidget.R

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@
1010
#' @param maxLabelLength Integer. Line wrapping will occur when the label of the node has width more than this value * 8 (pixels per char). Defaults to 25.
1111
#' @param nodeHeight Height of each node in pixels. Defaults to 100 pixels.
1212
#' @param tooltip Tooltip to attach to each node.
13+
#' @param treeColors TODO. not used. remove from callees
14+
#' @param categoryLegend TODO. not used. remove from callees
1315
#' @param terminalDescription Logical. Add description for terminal nodes? Defaults to FALSE.
1416
#' @param numeric.distribution Logical. Show numerical distribution for each node? If regression tree, then a histogram is plotted. If classification tree, then a horizontal bar plot is drawn. Defaults to TRUE.
15-
#'
16-
#'
17+
#' @param width The width of the generated widget.
18+
#' @param height The height of the generated widget.
19+
#'
20+
#'
1721
#' @import htmlwidgets
1822
#'
1923
#' @export
@@ -30,7 +34,7 @@ SankeyTree <- function(
3034
categoryLegend = FALSE, # TODO. not used. remove from callees
3135
terminalDescription = FALSE,
3236
numeric.distribution = TRUE,
33-
width = NULL,
37+
width = NULL,
3438
height = NULL) {
3539

3640
# forward options using x

0 commit comments

Comments
 (0)