如何为自己的R包创建新闻函数

如何为自己的R包创建新闻函数,r,r-package,R,R Package,我正在创建一个R包,现在正在处理NEWS文件。我在inst子文件夹中有一个.Rd文件,我希望通过自定义函数调用该文件,如my_pckg_news()。我在gamlss包中看到了这一点,该包将gamlssNews()作为调用NEWS.txt文件的自定义函数 因此,我是否可以创建一个类似的函数,以便在调用此函数时,在RStudio的帮助部分显示NEWS.Rd文件?我们使用?函数名显示相应的Rd文件的方式 编辑:添加了sample.Rd文件 我在这里面临的另一个问题是,f1,f2无法打印。这个文件并没

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

因此,我是否可以创建一个类似的函数,以便在调用此函数时,在RStudio的帮助部分显示
NEWS.Rd
文件?我们使用
?函数名
显示相应的
Rd
文件的方式

编辑:添加了sample.Rd文件 我在这里面临的另一个问题是,
f1
f2
无法打印。这个文件并没有加载到帮助部分(属于
RStudio
),而是直接打印到
R
控制台经过一些阅读、试用(很多!)和@nrussell的帮助,我能够为我的新闻文件定制功能

简言之:

  • 在主目录(存在
    DESCRIPTION
    etc)文件中创建
    inst
    子文件夹

  • inst
    文件夹内,创建另一个子文件夹
    doc
    ,在其中保存
    NEWS.txt
    文件

  • 现在创建一个
    .R
    文件,其中包含要保留为自定义新闻函数的函数名,调用该函数时将显示
    新闻
    文件。您可以将此文件名作为
    别名
    放在
    .Rd
    文件中,这样就不需要为此文件创建单独的
    .Rd
    文件

  • 在该函数中,编写一行代码加载
    .txt
    文件
    file.show(system.file(“doc”、“NEWS.txt”、package=“your\u pckg\u name”))

  • 还可以尝试构建
    .onAttach()
    函数,以便在加载包时显示欢迎消息。在此,您还可以提及自定义新闻功能的名称

  • 最终结果:=调用您的新闻函数


  • 希望这对未来的用户有帮助

    文件的格式如何?你可能应该把它包括在你的问题中。我想
    .Rd
    文件,因为这可能是你的软件包需要附带的。你的示例
    NEWS.Rd
    。你能用我的示例包重现这个问题吗?我把它放在
    inst/
    文件夹中--我认为这是
    NEWS.Rd
    @nrussell唯一可以接受的位置,我能解决这个问题。。。非常感谢您的支持!
    \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
        }
      }
    }