2

所以我目前正在创建一个基于活动 R 脚本生成 HTML 报告的包。可以通过在控制台中运行该函数来创建此报告。看起来像这样mypackage::myfunction()

举tidyverse个例子，当你tidyverse::在这个包中输入一些函数时，会出现在一个弹出的下拉列表中（如果它没有立即显示，你可能需要按键盘上的 Tab）。当您将鼠标悬停在其中一个功能上时，会出现一个简短的摘要/帮助文本来描述它的作用。如何将它添加到我的包函数中？

tidyverse 函数

另外，我注意到对于mypackage::某些我不希望向最终用户显示的功能出现。有没有办法可以从这个列表中删除一些功能？

没有在网上找到任何东西，所以我非常感谢您对此的任何意见:)

4

1 回答 1

2

您看到的是函数文档字符串。强烈建议您也为您的函数编写这些。

它看起来像这样（参见源代码）：

library(docstring)

mypaste <- function(x, y = "!"){
  #' Paste two items
  #' 
  #' @description This function pastes two items
  #' together.  
  #'
  #' By using the description tag you'll notice that I
  #' can have multiple paragraphs in the description section
  #' 
  #' @param x character. The first item to paste
  #' @param y character. The second item to paste Defaults to "!" but
  #' "?" would be pretty great too
  #' @usage mypaste(x, y)
  #' @return The inputs pasted together as a character string.
  #' @details The inputs can be anything that can be input into
  #' the paste function.
  #' @note And here is a note. Isn't it nice?
  #' @section I Must Warn You:
  #' The reference provided is a good read.
  #' \subsection{Other warning}{
  #'   It is completely irrelevant to this function though.
  #' }
  #' 
  #' @references Tufte, E. R. (2001). The visual display of 
  #' quantitative information. Cheshire, Conn: Graphics Press.
  #' @examples
  #' mypaste(1, 3)
  #' mypaste("hey", "you")
  #' mypaste("single param")
  #' @export
  #' @importFrom base paste

  return(paste(x, y))
}

当你检查它时：

?mypaste

Paste two items

Description:
     This function pastes two items together.
     By using the description tag you'll notice that I can have
     multiple paragraphs in the description section

Usage:
     mypaste(x, y)
     
Arguments:
       x: character. The first item to paste
       y: character. The second item to paste Defaults to "!" but "?" would be pretty great too

Details:
     The inputs can be anything that can be input into the paste
     function.

Value:
     The inputs pasted together as a character string.

I Must Warn You:
     The reference provided is a good read.

Other warning:
       It is completely irrelevant to this function though.


Note:
     And here is a note. Isn't it nice?

References:
     Tufte, E. R. (2001). The visual display of quantitative
     information. Cheshire, Conn: Graphics Press.

Examples:
     mypaste(1, 3)
     mypaste("hey", "you")
     mypaste("single param")

有关文档字符串的更多详细信息R：

但请记住不要过度使用您的文档。这里有一些好的代码文档的好资源：

于 2021-04-05T05:41:57.843 回答