Skip to content

Commit

Permalink
Remove documentation for low-level functions
Browse files Browse the repository at this point in the history
  • Loading branch information
rlbarter committed Feb 5, 2017
1 parent 79bf00e commit 18059e2
Showing 1 changed file with 0 additions and 45 deletions.
45 changes: 0 additions & 45 deletions R/labels.R
Original file line number Diff line number Diff line change
@@ -1,27 +1,4 @@

#' Generate clustered heatmap labels.
#'
#'
#'
#' @param membership a vector specifying the cluster membership.
#' @param label.col a vector specifying cluster/variable label color palette.
#' @param label.text.col a character or character vector specifying the
#' cluster/variable label text color.
#' @param bottom.label.text.size the size of the bottom heatmap label text. The
#' default is 5.
#' @param left.label.text.size the size of the left heatmap label text. The
#' default is 5.
#' @param label.text.alignment the text alignment of the label text. The
#' default is "center". Alternate options are "left" and "right".
#' @param location will these labels be on the bottom ("bottom") or on the left
#' ("left)?
#' @param text.angle number of degrees to rotate the text on the left
#' cluster/variable labels.
#' @return A ggplot2 object of heatmap labels.
#' @importFrom magrittr "%>%"



generate_cluster_label <- function(membership,
location = c("bottom", "left"),
label.col = NULL,
Expand Down Expand Up @@ -198,28 +175,6 @@ generate_cluster_label <- function(membership,



#' Generate heatmap variable labels.
#'
#'
#'
#' @param names a vector specifying the label names.
#' @param label.col a vector specifying the cluster/variable label color palette.
#' @param label.text.col a character or character vector specifying the
#' cluster/variable label text color.
#' @param bottom.label.text.size the size of the bottom heatmap label text. The
#' default is 5.
#' @param left.label.text.size the size of the left heatmap label text. The
#' default is 5.
#' @param label.text.alignment the text alignment of the label text. The
#' default is "center". Alternate options are "left" and "right".
#' @param location will these labels be on the bottom ("bottom") or on the left
#' ("left)?
#' @param text.angle number of degrees to rotate the text on the left
#' cluster/variable labels.
#' @return A ggplot2 object of heatmap labels.
#' @importFrom magrittr "%>%"


generate_var_label <- function(names,
location = c("bottom", "left"),
label.col = NULL,
Expand Down

0 comments on commit 18059e2

Please sign in to comment.