在 Roxygen 中记录时：如何在 @details 中制作逐项列表？

发布于 2025-01-05 12:19:50 字数 242 浏览 1 评论 0原文

例如，在 @details 部分中向 roxygen2 添加逐项列表的适当语法是什么？我可以创建一个 Latex 列表环境吗？

看来换行符被简单地忽略了，即

#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#' 
#' parameter 2: stuff

谢谢！

原文

What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section? Can I create a latex list environment?

It seems that line breaks are simply ignored, i.e.

#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#' 
#' parameter 2: stuff

thanks!

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

梦中的蝴蝶 2025-01-12 12:19:50

这是遵循您的问题表述的 roxygen2 示例。

##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##'  \item{"parameter 1"}{Stuff}
##'  \item{"parameter 2"}{Stuff}
##' }
##'

这将允许您在详细信息部分使用逐项列出。您还可以在@param 部分中使用它。

希望这有帮助。

Here is a roxygen2 example following your problem formulation.

##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##'  \item{"parameter 1"}{Stuff}
##'  \item{"parameter 2"}{Stuff}
##' }
##'

This will allow you to use itemize in details section. You can also use it in the @param sections.

Hope this helps.

回复收藏 0 原文

层林尽染 2025-01-12 12:19:50

从 roxygen2 6.0.0 开始，您可以直接在 R 文档中使用 markdown。

#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md

要使用此功能，请在描述中包含 Roxygen: list(markdown = TRUE) 来为整个包打开 markdown，或者将 @md 标签添加到单个文件中。

Since roxygen2 6.0.0 you can use markdown directly in your R documentation.

#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md

To use this either include Roxygen: list(markdown = TRUE) in your description to turn markdown on for the whole package or add the @md tag to a single file.

回复收藏 0 原文

~没有更多了~