R包/函数 - 为函数参数添加黄色注释框

时间:2017-09-30 11:17:10

标签: r package rstudio devtools roxygen2

我正在考虑编写我的第一个R-package,并且想知道当你将鼠标悬停在函数参数上时(当你在函数中点击tab时),如何添加那些弹出的黄色注释框。见这里:

Example

这是我的代码:

#' A web function
#'
#' This function allows you to call a website.
#' @param url put in a url
#' @keywords web
#' @export
#' @examples
#' webpage("google")

webpage <- function(url){
    if(!is.character(url)){
       url <- as.character(url)
} else{
     utils::browseURL(paste0("https://www.", url, ".com", collapse = ","))
  }
}

我使用带有roxygen2的devtools来记录和构建软件包 - 所有文件都存在,并且软件包/函数在安装和加载后工作。唯一的问题是,我写的评论#' @param url put in a url并没有显示为黄色框。

任何想法可能是什么问题?

1 个答案:

答案 0 :(得分:0)

问题解决了......显然,当你有一个带有多个参数的函数时,你会得到一个所述参数的列表,如上图所示。当只有一个参数时,您必须开始键入参数并使用代码完成来显示列表。然后,当您将鼠标悬停在“url”参数上时,它会显示黄色描述框...