R roxygen2：不在列表中顯示功能

Question

這個問題是關於使用roxygen2的，而不是關於如何覆蓋函數的。

我正在將roxygen2用於CRAN軟件包，並且正在嘗試實現以下目標：

有一個名為my.function的函數，其函數名我想用my_function替換。

我想逐步執行此操作-因此一段時間內兩個函數名稱都將可用。

第一步，我要具備以下條件：

1. 如果用戶顯式調用?my.function ，則應進入my.function函數的文檔（或my_function的文檔）。

2. 但是，如果用戶調用help(package="myPackage") my.function將不會出現在功能列表中

背景是，如果用戶明確搜索舊函數名稱，他們仍然會找到它。 但是，如果他們只是通常在搜索可用功能（因為它們是軟件包的新功能），那么它們只會獲得新名稱。

我怎樣才能做到這一點？

我正在嘗試以下氧氣標簽的組合：

@noRd
@alias
@describeIn
@rdname

但是我無法達到我想要的結果。 我是在專門詢問roxgen2文檔部分，而不是在一般情況下覆蓋R中的函數。

Answer 1

您可以通過在roxygen注釋@keywords internal添加@keywords internal來禁止將函數在軟件包手冊中列出（請參閱R軟件包的Object文檔部分），但是正如Hong Ooi所提到的，正確的方法可能是棄用my.function （請參見R包的釋放包部分）。