簡體   English   中英

從 R package 中提取 function 參數描述

[英]Extract function argument description from R package

我知道有一些方法可以使用例如rlang::fn_fmls 但是是否可以從 package 文檔中提取其中一個 arguments 的描述?

例如,如果我想將na.rm參數的描述提取到base::sum()怎么辦?

我在想像:

get_argument_description(fn = 'base::sum', arg = 'na.rm')

返回:

"logical. Should missing values (including NaN) be removed?"

您可以嘗試閱讀 function 和grep所在行的相關幫助文件\item{argument} 但是,允許使用多行幫助文本,如果下一行不以\開頭,您也想抓住它。

這個答案顯示了一種訪問文件的方法,然后只需抓住正確的行。 我還想在tools中突出顯示不同的 function,

tools:::.Rd_get_text()

這幾乎可以讓你到達你想要的地方,(如果你找到正確的路線)

library(tools)
db = Rd_db("base")
tools:::.Rd_get_text(x = db[["sum.Rd"]])[21] # 21 is the line you want here

[1] "   na.rm: logical.  Should missing values (including 'NaN') be removed?"

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM