Skip to content

Commit 7284aa3

Browse files
authored
Merge pull request #122 from stemangiola/add-layer-size
fix docs
2 parents 21a0158 + 7e5681d commit 7284aa3

9 files changed

+37
-16
lines changed

R/methods.R

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,7 @@ setMethod("annotation_bar", "InputHeatmap", function(.data,
648648
#'
649649
#' @param .data A `InputHeatmap`
650650
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
651+
#' @param .size A column name or a double. The size of the elements of the layer.
651652
#'
652653
#'
653654
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -701,6 +702,7 @@ setMethod("layer_arrow_up", "InputHeatmap", function(.data,...,
701702
#'
702703
#' @param .data A `InputHeatmap`
703704
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
705+
#' @param .size A column name or a double. The size of the elements of the layer.
704706
#'
705707
#'
706708
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -753,6 +755,7 @@ setMethod("layer_arrow_down", "InputHeatmap", function(.data,...,
753755
#'
754756
#' @param .data A `InputHeatmap`
755757
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
758+
#' @param .size A column name or a double. The size of the elements of the layer.
756759
#'
757760
#'
758761
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -805,6 +808,7 @@ setMethod("layer_point", "InputHeatmap", function(.data,...,
805808
#'
806809
#' @param .data A `InputHeatmap`
807810
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
811+
#' @param .size A column name or a double. The size of the elements of the layer.
808812
#'
809813
#'
810814
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -856,6 +860,7 @@ setMethod("layer_square", "InputHeatmap", function(.data,...,
856860
#'
857861
#' @param .data A `InputHeatmap`
858862
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
863+
#' @param .size A column name or a double. The size of the elements of the layer.
859864
#'
860865
#'
861866
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -908,6 +913,7 @@ setMethod("layer_diamond", "InputHeatmap", function(.data,...,
908913
#'
909914
#' @param .data A `InputHeatmap`
910915
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
916+
#' @param .size A column name or a double. The size of the elements of the layer.
911917
#'
912918
#'
913919
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -960,6 +966,7 @@ setMethod("layer_star", "InputHeatmap", function(.data,...,
960966
#'
961967
#' @param .data A `InputHeatmap`
962968
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
969+
#' @param .size A column name or a double. The size of the elements of the layer.
963970
#'
964971
#'
965972
#' @details It uses `ComplexHeatmap` as visualisation tool.
@@ -1016,7 +1023,7 @@ setMethod("layer_asterisk", "InputHeatmap", function(.data,...,
10161023
#' @param .data A `InputHeatmap`
10171024
#' @param ... Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.
10181025
#' @param .value A column name or character string.
1019-
#' @param .size A column name or a double.
1026+
#' @param .size A column name or a double. The size of the elements of the layer.
10201027
#'
10211028
#'
10221029
#' @details It uses `ComplexHeatmap` as visualisation tool.

man/layer_arrow_down-method.Rd

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

man/layer_arrow_up-method.Rd

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

man/layer_asterisk-method.Rd

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

man/layer_diamond-method.Rd

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

man/layer_point-method.Rd

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

man/layer_square-method.Rd

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

man/layer_star-method.Rd

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

man/layer_text-method.Rd

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

0 commit comments

Comments
 (0)