在roxygen2中提供两种用途

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

我试过：

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

这使得：

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

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

如何使用roxygen在usage字段中创建两个项目，使它们位于单独的行中（例如

？lappy

）

编辑：根据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

相关矩阵和上三角数据帧之间的转换 #' #'在相关矩阵和上三角数据帧之间转换的工具 #'值和可变组件。dataframe在应用时更加直观 #'函数，而相关矩阵更直观直观。 #' #“@别名矩阵2向量，向量矩阵2 #“@usage matrix2vectors（cor.mat） #“@用法向量2矩阵（cor.vect） #“@rdname matrix2向量 #“@param cor.mat一个正方形对称矩阵，对角线为1s（相关矩阵）。 #“@param cor.vect在第一个数据帧中包含相关矩阵的行变量 #'列，第二列中的列名以及 #"第三栏。 #“@出口 #“@示例

---

#（mat我想你应该使用

@rdname

，放弃使用

@use

因此，选择一个名称并对所有这些名称使用。例如，将其添加到所有roxygen块中

---

#@rdname matrix2vectors

为什么要使用

@usage

标记？请参阅如何使用多个usages@TylerRinker-您可以（从您自己的一个repo中）查看此文件，了解rdname的示例用法：在我的辩护中，我确实得到了一些帮助来设置该存储库；-）@Tylerlinker机器人的帮助算是真正的帮助吗？