我正在創建一個R包，現在正在處理NEWS文件。我在inst子文件夾中有一個.Rd文件，我希望通過像my_pckg_news()這樣的自定義函數來調用該文件。我在gamlss包中看到這個，它具有gamlssNews()作爲調用NEWS.txt文件的自定義函數。如何爲您自己的R包創建新聞功能

所以我可以創建一個類似的功能，當調用此函數時，應該在RStudio的幫助部分顯示NEWS.Rd文件？我們有?function_name顯示各自Rd文件的方式。

編輯：添加樣品.Rd文件

\name{my_package} 
\title{News for package \pkg{my_package}} 

\section{}{ 
    \itemize{ 
    \item item1 
    }  
} 


\section{Version 0.1}{ 
    \subsection{f1}{ 
    \itemize{ 
     \item item1 
     \item item2 
    } 
    } 
    \subsection{f2}{ 
    \itemize{ 
     \item item1 
    } 
    } 
}

我這裏面臨的另一個問題是，f1，f2不會被打印出來。並且這個文件沒有加載到幫助部分（RStudio），而是直接打印到R控制檯

來源

2017-05-08 joel.wilson

文件格式如何？你應該把它包括在你的問題中。 – nrussell

我想'.Rd'文件，因爲這可能是您的軟件包需要隨附的東西。 – nrussell

你的樣品'NEWS.Rd' [爲我工作]（https://github.com/nathan-russell/news/blob/master/README.md）。你能用我的示例包重現問題嗎？ – nrussell

經過一些閱讀，試用（很多！）和@nrussell的幫助，我能夠有一個爲我的新聞文件定製功能。

簡單：

在你的主目錄下創建一個子文件夾inst存在（其中DESCRIPTION等）的文件。
裏面的inst文件夾創建另一個子文件夾doc其中你應該保存你的NEWS.txt文件。
現在創建一個.R文件，其中包含要作爲定製新聞功能保留的功能名稱，該功能在被調用時應顯示NEWS文件。你可以有這個文件名作爲alias在.Rd filew之一，所以你不必創建一個單獨的文件.Rd此
在這個函數編寫加載.txt文件中的一行代碼。 file.show(system.file("doc", "NEWS.txt", package = "your_pckg_name"))
還嘗試構建.onAttach()函數，例如在包加載時顯示歡迎消息。在這裏，您還可以提及您定製的新聞功能的名稱。
最終結果：=打電話給你的新聞功能!!!!

希望這有助於未來的用戶！

來源

2017-05-10 11:07:14

如何爲您自己的R包創建新聞功能

編輯：添加樣品.Rd文件

回答

相關問題