From 9d3394871d289c874074807c458d4b941e1b6797 Mon Sep 17 00:00:00 2001 From: Robrecht Cannoodt Date: Fri, 14 Jul 2023 07:27:12 +0200 Subject: [PATCH] fix man (#22) * fix man * update news --- NEWS.md | 2 ++ R/funky_heatmap.R | 5 +---- man/funky_heatmap.Rd | 4 +--- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/NEWS.md b/NEWS.md index 0b36844..8e90958 100644 --- a/NEWS.md +++ b/NEWS.md @@ -17,6 +17,8 @@ * Throw warning if magick is not installed or if image is not found (#18). +* Minor fixes to the documentation (#22). + ## BUG FIXES * Fix missing 1.0 label in legend due to limitations in floating-point arithmetic. diff --git a/R/funky_heatmap.R b/R/funky_heatmap.R index 9abee87..8f490ae 100644 --- a/R/funky_heatmap.R +++ b/R/funky_heatmap.R @@ -40,13 +40,10 @@ #' * `hjust`: Horizontal alignment of the bar, must be between \[0,1\] #' (only for `geom = "bar"`). #' -#' * `hjust`: Horizontal alignment of the label, must be between \[0,1\] -#' (only for `geom = "text"`). -#' #' * `vjust`: Vertical alignment of the label, must be between \[0,1\] #' (only for `geom = "text"`). #' -#' * `size`: Size of the label, must be between \[0,1\] +#' * `size`: Size of the label, must be a numeric value #' (only for `geom = "text"`). #' #' * `label`: Which column to use as a label (only for `geom = "text"`). diff --git a/man/funky_heatmap.Rd b/man/funky_heatmap.Rd index 785ad2f..f5a68e3 100644 --- a/man/funky_heatmap.Rd +++ b/man/funky_heatmap.Rd @@ -47,11 +47,9 @@ If so, the width of that column will be inherited. \item \code{legend}: Whether or not to add a legend for this column. \item \code{hjust}: Horizontal alignment of the bar, must be between [0,1] (only for \code{geom = "bar"}). -\item \code{hjust}: Horizontal alignment of the label, must be between [0,1] -(only for \code{geom = "text"}). \item \code{vjust}: Vertical alignment of the label, must be between [0,1] (only for \code{geom = "text"}). -\item \code{size}: Size of the label, must be between [0,1] +\item \code{size}: Size of the label, must be a numeric value (only for \code{geom = "text"}). \item \code{label}: Which column to use as a label (only for \code{geom = "text"}). \item \code{directory}: Which directory to use to find the images (only for \code{geom = "image"}).