Skip to content

Commit

Permalink
fix Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yunuuuu committed Nov 7, 2024
1 parent fd2f83c commit fb7e86e
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions R/align-.R
Original file line number Diff line number Diff line change
@@ -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`.
#'
Expand Down Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion R/align-add.R
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions man/align.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions tests/testthat/test-layout_quad.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)))
Expand All @@ -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())
Expand All @@ -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())
Expand Down
2 changes: 1 addition & 1 deletion tests/testthat/test-layout_stack.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)))
Expand Down

0 comments on commit fb7e86e

Please sign in to comment.