Is there a way to automatically update the documen

2020-04-03 16:56发布

I used 'package.skeleton()' to generate .Rd help files a few months ago. I have edited these files, and I have also changed the functions, removed some functions, added others. Is there a function that automates updating the Rd files?

update

A nice package was just released called Rd2roxygen, it is described by the author Yihui Xie on his blog.

As the name implies, this package allows one to retroactively insert documentation currently contained in .Rd into .R files. Sounds like a promising approach for both learning roxygen and for converting packages currently in development to R packages. Woo hoo. Thanks Yihui!

Based on answers by Joshua and Yihui, the answer appears to be: roxygen allows automatic updating of Rd files etc based on changes in the source .R code, and if I am not using roxygen currently, Rd2roxygen can help me migrate.

3条回答
戒情不戒烟
2楼-- · 2020-04-03 17:20

No, I don't think so.

But you could try re-running package.skeleton() for new or changed functions and then merge this by hand.

查看更多
你好瞎i
3楼-- · 2020-04-03 17:33

Rd2roxygen was designed to help package developers who have been "stuck" in the raw Rd files but want to switch to roxygen -- it can process Rd files and update the R scripts with roxygen comments. From then on, you can begin to enjoy the power of roxygen. So Rd2roxygen is not a direct answer, but it might help you with the transition.

查看更多
\"骚年 ilove
4楼-- · 2020-04-03 17:40

This doesn't specifically answer your question, but you may be interested in Roxygen.

查看更多
登录 后发表回答