无法在包文档中的@format标记下添加列表

Unable to add list under @format tag in package documentation

提问人:Abdu Kikhia 提问时间:11/15/2023 最后编辑:Abdu Kikhia 更新时间:11/16/2023 访问量:26

问:

我正在尝试将数据集文档添加到我的包中的函数中,并遵循 roxygen2 提供的关于记录其他对象的格式。但是,在使用更新软件包后,我总是收到错误devtools::document()

我正在尝试将文档添加到包中的函数中。我能够成功创建包,并且在加载时也能够使用这些功能。我正在尝试记录我的数据集函数并遵循此格式

#' @param data A data frame. See data_sample for formatting reference.
#' @format A data frame with the following columns:
#' \describe{
#'          \item{`Player Name`}{A chracter string. The name of the athlete}
#'          \item{`Age Group @ Testing`}{A chracter string. Athletes Age Group at the time of testing}
#'          \item{`Gender`}{A character String. The gender of the athlete}
#'          \item{`Testing Date`}{A date. The data collection date for each athlete}
#'          \item{`Birth Year`}{The year of birth for every athlete}
#' }

但是,在运行更新包后,我一直收到此错误devtools::document()

Warning messages:
1: [maturation_cm.R:8] @format has mismatched braces or quotes

因此,在.“man”文件夹中的 rd 文件。

我不知道我的格式是错还是什么?这是我第一次编写自己的包

R RSodio 开发工具 Roxygen2

评论


答:

0赞 J_F 11/15/2023 #1

您在这里的问题是缺少 的结束括号。此括号在 y0ur 代码中永远不会关闭。 只需添加以下代码的最后一行,您的示例就可以工作了。describe{

#' @format A data frame with the following columns:
#' \describe{
#'          \item{`Player Name`}{A chracter string. The name of the athlete}
#'          \item{`Age Group @ Testing`}{A chracter string. Athletes Age Group at the time of testing}
#'          \item{`Gender`}{A character String. The gender of the athlete}
#'          \item{`Testing Date`}{A date. The data collection date for each athlete}
#'          \item{`Birth Year`}{The year of birth for every athlete}
#'          }

评论

0赞 Abdu Kikhia 11/15/2023
我已经添加了闭括号,但我仍然收到相同的错误
0赞 Abdu Kikhia 11/16/2023 #2

发现 中的 @ 符号必须替换为 2 个 @ 符号才能看起来像这样.\item{`Age Group @ Testing`}\item{`Age Group @@ Testing`}

还有一些我不得不逃脱的 % 符号\%