diff --git a/R/align-.R b/R/align-.R index b1e4a60c..7e8c1dfd 100644 --- a/R/align-.R +++ b/R/align-.R @@ -1,6 +1,6 @@ -#' Create a New `Align` Object +#' Create a New `align` Object #' -#' `r lifecycle::badge('experimental')` An `Align` object interacts with the +#' `r lifecycle::badge('experimental')` An `align` object interacts with the #' `layout` object to reorder or split observations and, in some cases, add plot #' components to the `layout`. #' @@ -56,7 +56,7 @@ #' - [`stack_layout()`]: The layout matrix is used as is, aligning all plots #' along a single axis. #' -#' @return A new `Align` object. +#' @return A new `align` object. #' #' @examples #' align_gg() diff --git a/R/align-add.R b/R/align-add.R index 0c771657..72c8abaf 100644 --- a/R/align-add.R +++ b/R/align-add.R @@ -1,5 +1,5 @@ #################################################################### -# Following methods are used to add elements to `Align` object +# Following methods are used to add elements to `align` object align_add <- function(object, align, object_name) UseMethod("align_add") #' @importFrom ggplot2 ggplot_add diff --git a/man/align.Rd b/man/align.Rd index 153b12ef..73c1d884 100644 --- a/man/align.Rd +++ b/man/align.Rd @@ -4,7 +4,7 @@ \name{align} \alias{align} \alias{Align} -\title{Create a New \code{Align} Object} +\title{Create a New \code{align} Object} \usage{ align( align_class, @@ -83,10 +83,10 @@ warnings as necessary.} messages.} } \value{ -A new \code{Align} object. +A new \code{align} object. } \description{ -\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} An \code{Align} object interacts with the +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} An \code{align} object interacts with the \code{layout} object to reorder or split observations and, in some cases, add plot components to the \code{layout}. } diff --git a/tests/testthat/test-layout_quad.R b/tests/testthat/test-layout_quad.R index 46295c18..03bb0cb3 100644 --- a/tests/testthat/test-layout_quad.R +++ b/tests/testthat/test-layout_quad.R @@ -129,7 +129,7 @@ testthat::test_that("add `anno_init()` works well", { expect_no_error(quad_alignb(small_mat) + anno_init("l", small_mat)) }) -testthat::test_that("add `Align` object works well", { +testthat::test_that("add `align` object works well", { set.seed(1L) small_mat <- matrix(rnorm(72), nrow = 8) rownames(small_mat) <- paste0("row", seq_len(nrow(small_mat))) @@ -152,7 +152,7 @@ testthat::test_that("add `Align` object works well", { # quad_alignh() # for vertical direction, we must manually provide the data frame - # we cannot add `Align` object in top and bottom + # we cannot add `align` object in top and bottom expect_error(quad_alignh(small_mat) + anno_init("t", mtcars) + align_dendro()) @@ -170,7 +170,7 @@ testthat::test_that("add `Align` object works well", { # quad_alignv() # for horizontal direction, we must manually provide the data frame - # we cannot add `Align` object in left and right + # we cannot add `align` object in left and right expect_error(quad_alignv(small_mat) + anno_init("l", mtcars) + align_dendro()) diff --git a/tests/testthat/test-layout_stack.R b/tests/testthat/test-layout_stack.R index 0e7654d2..4b31e1fc 100644 --- a/tests/testthat/test-layout_stack.R +++ b/tests/testthat/test-layout_stack.R @@ -36,7 +36,7 @@ testthat::test_that("`stack_free` works well", { expect_identical(x@layout, NULL) }) -testthat::test_that("`stack_align` add `Align` object", { +testthat::test_that("`stack_align` add `align` object", { set.seed(1L) small_mat <- matrix(rnorm(72), nrow = 8) rownames(small_mat) <- paste0("row", seq_len(nrow(small_mat)))