From 0172cd4a261c760b9e3b979f5360e7220ba6339e Mon Sep 17 00:00:00 2001 From: yun Date: Wed, 26 Jun 2024 21:39:28 +0800 Subject: [PATCH] fix Docs --- R/gganno.R | 2 +- README.html | 5 ++--- README.md | 6 ++---- man/gganno.Rd | 2 +- vignettes/eheat.Rmd | 4 +--- 5 files changed, 7 insertions(+), 12 deletions(-) diff --git a/R/gganno.R b/R/gganno.R index 8bd45c3..cb3cf10 100644 --- a/R/gganno.R +++ b/R/gganno.R @@ -14,7 +14,7 @@ #' `ggplot(data, aes(.data$x))` / `ggplot(data, ggplot2::aes(y = .data$y))`. #' The original matrix will be converted into a long-data.frame (`gganno` always #' regard row as the observations) with following columns: -#' - `.slice`: the slice row (which = "row") or column (which = "column") +#' - `.slice`: the slice row (which = `"row"`) or column (which = `"column"`) #' number. #' - `.row_names` and `.column_names`: the row and column names of the original #' matrix (only applicable when names exist). diff --git a/README.html b/README.html index 2585066..b11e6c4 100644 --- a/README.html +++ b/README.html @@ -915,8 +915,7 @@

gganno

  • .row_index and .column_index: the row and column index of the original matrix.
  • x / y: indicating the x-axis (or y-axis) -coordinates. Don’t use [coord_flip][ggplot2::coord_flip] to flip -coordinates as it may disrupt internal operations.
    • +coordinates.
  • value: the actual matrix value of the annotation matrix.
    • @@ -1223,7 +1222,7 @@

    sessionInfo

    #> [8] base #> #> other attached packages: -#> [1] eheat_0.99.6 ggplot2_3.5.1 ComplexHeatmap_2.20.0 +#> [1] eheat_0.99.7 ggplot2_3.5.1 ComplexHeatmap_2.20.0 #> #> loaded via a namespace (and not attached): #> [1] utf8_1.2.4 generics_0.1.3 tidyr_1.3.1 diff --git a/README.md b/README.md index a38d0b5..84b2772 100644 --- a/README.md +++ b/README.md @@ -388,9 +388,7 @@ observations) with following columns. original matrix (only applicable when names exist). - `.row_index` and `.column_index`: the row and column index of the original matrix. -- `x` / `y`: indicating the x-axis (or y-axis) coordinates. Don’t use - \[coord_flip\]\[ggplot2::coord_flip\] to flip coordinates as it may - disrupt internal operations. +- `x` / `y`: indicating the x-axis (or y-axis) coordinates. - `value`: the actual matrix value of the annotation matrix. `gganno` can be seamlessly combined with both `ggheat` and @@ -747,7 +745,7 @@ sessionInfo() #> [8] base #> #> other attached packages: -#> [1] eheat_0.99.6 ggplot2_3.5.1 ComplexHeatmap_2.20.0 +#> [1] eheat_0.99.7 ggplot2_3.5.1 ComplexHeatmap_2.20.0 #> #> loaded via a namespace (and not attached): #> [1] utf8_1.2.4 generics_0.1.3 tidyr_1.3.1 diff --git a/man/gganno.Rd b/man/gganno.Rd index e3d3a89..5bf1395 100644 --- a/man/gganno.Rd +++ b/man/gganno.Rd @@ -56,7 +56,7 @@ Maintaining the internal limits along the heatmap to align well with The original matrix will be converted into a long-data.frame (\code{gganno} always regard row as the observations) with following columns: \itemize{ -\item \code{.slice}: the slice row (which = "row") or column (which = "column") +\item \code{.slice}: the slice row (which = \code{"row"}) or column (which = \code{"column"}) number. \item \code{.row_names} and \code{.column_names}: the row and column names of the original matrix (only applicable when names exist). diff --git a/vignettes/eheat.Rmd b/vignettes/eheat.Rmd index a467412..4c208aa 100644 --- a/vignettes/eheat.Rmd +++ b/vignettes/eheat.Rmd @@ -300,9 +300,7 @@ row as the observations) with following columns. matrix (only applicable when names exist). - `.row_index` and `.column_index`: the row and column index of the original matrix. -- `x` / `y`: indicating the x-axis (or y-axis) coordinates. Don't use - [coord_flip][ggplot2::coord_flip] to flip coordinates as it may disrupt - internal operations. +- `x` / `y`: indicating the x-axis (or y-axis) coordinates. - `value`: the actual matrix value of the annotation matrix. `gganno` can be seamlessly combined with both `ggheat` and