Rstudio自己的方法/函數minihelp

如果我編寫一個方法或函數，如何獲得寫入函數時顯示的「minihelp」（其特殊術語我不知道）？例如對於「情節」它存在;在一種「工具提示」Rstudio自己的方法/函數minihelp

x= 
y= 
... =

鍵入

>plot([TAB]

那麼下面的節目，如果你選擇，例如「X」，再經過二級以下提示顯示：

x 
the coordinates of points in the plot. Alternatively, a single plotting 
structure, function or any R object with a plot method can be provided.

一些信息，但不是關鍵的問題：我正在與Rstudio合作，爲ExpressionSet類編寫多個S4泛型/方法。可悲的是我無法找到一個很酷的谷歌關鍵字，所以我希望你能幫助我！

伊迪絲：以下question是關於我的一樣，但我仍然認爲我已經寫包正在進行的問題，每一個功能是記錄與roxygen，我也跟着哈德利描述。儘管如此，這些工具提示並沒有顯示出來。

在鏈接的問題，它說，「幫助文件必須生成」 - 我假設生成？myS4Method顯示適當的幫助頁面。有任何想法嗎？

來源

2017-09-21 groebsgr

這將是一個重複的是 - 但即使通過創建一個包它不工作.. – groebsgr

您正在尋找的功能來自RStudio解析軟件包文檔的方式。如果您創建了一個包，您可以將Roxygen註釋添加到您的函數或類中。這些註釋在創建包到文檔文件中時會被解析，這些文檔可以看作是函數的幫助。

如果您運行命令?plot，您將看到一個參數列表。這些是可以傳遞給函數的參數，這是RStudio中的工具提示告訴你的。

要讓RStudio爲您提供有關您正在使用的功能的信息，您應該將您的S4課程打包到一個包中（Hadley Wickham's tutorial），並確保它們被正確記錄。 RStudio將負責其餘部分。

來源

2017-09-21 15:22:53 Eumenedies

因此，我已經使用Roxygen註釋 - 文檔devtools :: document（）運行時沒有警告或錯誤。？「myfunction」正常工作，所有參數都在那裏正確描述。儘管如此，工具提示並未顯示 - 我是否錯過了某些部分？ – groebsgr

您是否正在從包裝中加載功能？查看哈德利對[this]的評論（https://stackoverflow.com/questions/21565526/is-it-possible-to-get-rstudio-to-show-function-arguments-and-descriptions-for-cu）的問題。 – Eumenedies

是的我是:(必須有我監督的東西... – groebsgr

Rstudio自己的方法/函數minihelp

回答

相關問題