From 238f18230d549aa4d50bc3d765fecc418b40a338 Mon Sep 17 00:00:00 2001 From: Yunuuuu Date: Mon, 9 Dec 2024 12:56:40 +0800 Subject: [PATCH] fix docs --- R/align-reorder.R | 8 ++++---- man/align_reorder.Rd | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/align-reorder.R b/R/align-reorder.R index 5d9bb21c..bac34140 100644 --- a/R/align-reorder.R +++ b/R/align-reorder.R @@ -3,10 +3,10 @@ #' @details #' `r lifecycle::badge('experimental')` #' -#' The `align_reorder()` function differs from `align_order()` in that the `wts` -#' argument in `align_order()` must return atomic weights for each observation. -#' In contrast, the `stat` argument in `align_reorder()` can return more complex -#' structures, such as [hclust][stats::hclust] or +#' The `align_reorder()` function differs from `align_order()` in that the +#' `weights` argument in `align_order()` must return atomic weights for each +#' observation. In contrast, the `stat` argument in `align_reorder()` can +#' return more complex structures, such as [hclust][stats::hclust] or #' [dendrogram][stats::as.dendrogram], among others. #' #' Typically, you can achieve the functionality of `align_reorder()` using diff --git a/man/align_reorder.Rd b/man/align_reorder.Rd index d3963745..d8885fa7 100644 --- a/man/align_reorder.Rd +++ b/man/align_reorder.Rd @@ -49,10 +49,10 @@ Reorders layout observations based on specific statistics. \details{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} -The \code{align_reorder()} function differs from \code{align_order()} in that the \code{wts} -argument in \code{align_order()} must return atomic weights for each observation. -In contrast, the \code{stat} argument in \code{align_reorder()} can return more complex -structures, such as \link[stats:hclust]{hclust} or +The \code{align_reorder()} function differs from \code{align_order()} in that the +\code{weights} argument in \code{align_order()} must return atomic weights for each +observation. In contrast, the \code{stat} argument in \code{align_reorder()} can +return more complex structures, such as \link[stats:hclust]{hclust} or \link[stats:dendrogram]{dendrogram}, among others. Typically, you can achieve the functionality of \code{align_reorder()} using