如何读取R函数的元数据?

如何读取R函数的元数据?,r,R,假设在“R软件包”一书中有一个R函数“add” 谢谢你的建议 要么是形式的,这只是部分答案,要么可能是重复的。谢谢!“formals”只返回参数的名称:“formals(add)”=>“$x”和“$y”。但是如何得到这些参数的描述“'A number'”?安德烈,不幸的是,formals不会给你所有的额外信息(它会告诉你x=,但不会告诉你A number)。前面的注释是两件事之一:(1)让roxygen2转换成R帮助文件(*.Rd),可通过帮助(“添加”)或?添加,假设这是在R包中;即使1不是真

假设在“R软件包”一书中有一个R函数“add”


谢谢你的建议

要么是
形式的
,这只是部分答案,要么可能是重复的。谢谢!“formals”只返回参数的名称:“formals(add)”=>“$x”和“$y”。但是如何得到这些参数的描述“'A number'”?安德烈,不幸的是,
formals
不会给你所有的额外信息(它会告诉你
x=
,但不会告诉你
A number
)。前面的
注释是两件事之一:(1)让
roxygen2
转换成R帮助文件(
*.Rd
),可通过
帮助(“添加”)
?添加
,假设这是在R包中;即使1不是真的,(2)它们只是函数的结构化注释;不幸的是,它们不在函数的定义范围内,因此即使您可以在函数中保留注释,它们也不是……因此它们只能在源文件本身中访问。您会注意到,我在注释中特别指出,
formals
只是部分答案,w这表明我承认它只会给你参数名。我链接到的另一个问题是我知道的唯一的另一个选项,它要求你从字面上解析整个帮助文本。非常感谢@joran!要么
formals
,这只是一个部分答案,要么可能是重复的。谢谢!formals“只返回参数的名称:”formals(add)”=>“$x”和“$y”。但是如何获得这些参数的描述“'A number”?安德烈,不幸的是,
formals
不会提供所有这些附加信息(它会告诉你
x=
,但不会告诉你
A number
)。前面的
#“
注释是两件事之一:(1)对于
roxygen2
,将其转换为R帮助文件(
*.Rd
),可通过
帮助(“添加”)
访问,假设这是在R包中;即使1不是真的,(2)它们只是函数的结构化注释;不幸的是,它们不在函数的定义范围内,因此即使您可以在函数中保留注释,它们也不是……因此它们只能在源文件本身中访问。您会注意到,我在注释中特别指出,
formals
只是部分答案,w这表明我承认它只会给你参数名。我链接到的另一个问题是我知道的唯一其他选项,它要求你逐字解析整个帮助文本。非常感谢@joran!
#' Add together two numbers
#' 
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
add <- function(x, y) {
  x + y
}
get_function_meta_data('add')
> 'param x' =  'A number'
> 'param y' = 'A number'