r - 在 roxygen2 中提供两种用法

我在同一个家庭中有两个功能。我正在使用 roxygen2 进行记录，可以将它们放在同一个帮助文件中，但不知道如何使文档中的使用字段具有这两个功能。

我试过了:

#' @usage matrix2vectors(cor.mat) vectors2matrix(cor.vect)

这给出:

matrix2vectors(cor.mat) vectors2matrix(cor.vect)

我尝试了逗号分隔，它只给出了第一个，我尝试了单独的用法标签，它只使用了第一个。

如何使用 roxygen 在使用字段中制作两个项目，以便它们位于不同的行上(例如 ?lapply )？

编辑:根据 GeeSee 的问题，整个 .R 文件

#' Convert Between Correlation Matrix and Upper Triangle Dataframe
#'
#' Tools to convert between a correlation matrix and a dataframe of upper triangle
#' values and variable components.  The dataframe is more intuitive for applying
#' functions while the correlation matrix is more intuitive to visualize.
#'
#' @aliases matrix2vectors, vectors2matrix
#' @usage matrix2vectors(cor.mat)
#' @usage vectors2matrix(cor.vect)
#' @rdname matrix2vectors
#' @param cor.mat A square, symetrical matrix with a diagonas of 1s (a correlation matrix).
#' @param cor.vect A dataframe with the row variables of the correlation matrix in the first
#' column, the column names in the second column and the corresponding correlations in the
#' third column.
#' @export
#' @examples
#' (mat <- round(cor(mtcars[, 1:5]), 2))
#' matrix2vectors(mat)
#' cor.vect <- matrix2vectors(round(cor(mtcars[, 1:5]), 2))
#' vectors2matrix(cor.vect)
matrix2vectors <- function(cor.mat) {
    nmscor <- colnames(cor.mat)
    rows <- nmscor[1:(length(nmscor)-1)]
    cols <- nmscor[2:length(nmscor)]
    rowdim <- 1:length(rows)
    row.var <- rows[unlist(lapply(seq_along(rowdim), function(i) rowdim[1:i]))]
    col.var <- rep(cols, 1:length(cols))
    cors <- cor.mat[upper.tri(cor.mat)]
    data.frame(row.var, col.var, cors)
}
#' @export

#' @export
vectors2matrix <- function(cor.vect) {
    dimnms <- unique(c(as.character(cor.vect[, 1]),
        as.character(cor.vect[, 2])))
    mat <- matrix(NA, length(dimnms), length(dimnms))
    mat[upper.tri(mat)] <- cor.vect[, 3]
    diag(mat) <- 1
    dimnames(mat) <- list(dimnms, dimnms)
    mat[lower.tri(mat)] <- t(mat)[lower.tri(mat)]
    mat
}
#' @export

最佳答案

我想你想使用@rdname，放弃使用@usage的想法

因此，选择一个名称并将其用于所有人。例如将此添加到您所有的 roxygen 块中
#' @rdname matrix2vectors

关于r - 在 roxygen2 中提供两种用法，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/13629080/