如何为自己的R包创建新闻功能

Question

我正在创建一个R包，现在处理NEWS文件。我在.Rd子文件夹中有一个inst文件，我希望通过自定义函数my_pckg_news()调用该文件。我在gamlss包中看到了这个，它包含gamlssNews()作为调用NEWS.txt文件的自定义函数。

那么我可以创建一个类似的函数，这样当调用这个函数时，会在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控制台

Answer 1

经过一些阅读，试验（很多！）和@nrussell的帮助，我能够为我的新闻文件定制功能。

简而言之：

1. 在主目录中创建inst子文件夹（其中DESCRIPTION等）文件存在。

2. 在inst文件夹中创建另一个子文件夹doc，其中您应保存NEWS.txt文件。

3. 现在创建一个.R文件，其中包含您要保留的函数名称作为自定义新闻函数，该函数在调用时将显示NEWS文件。您可以在alias filew之一中将此文件名设为.Rd，这样您就无需为此创建单独的.Rd文件

4. 在此函数内部编写一行加载.txt文件的行代码。 file.show(system.file("doc", "NEWS.txt", package = "your_pckg_name"))

5. 还尝试构建.onAttach()函数，例如在加载包时显示欢迎消息。在这里，您还可以提到自定义新闻功能的名称。

6. 最终结果：=致电您的新闻功能!!!!

希望这有助于未来的用户！