在包含R/Cpp代码的R包中使用roxygen2作为R函数

Question

我有一个Cpp函数,使用Rcpp packgae在R函数内部调用.R函数接受inputDataFrame并使用Cpp函数(也接受DataFrame)来计算药物量(A1)作为时间的函数.然后R返回inputDataFrame计算量的添加列A1.

我想roxygen2在RStudio中使用包来对R函数(而不是Cpp函数)进行documnet.但是,当我使用roxygen2注释(如下所示)时,它没有按照您在构建模型时所期望的方式生成*.RD文件和帮助页面.请注意,当我的包只包含R函数时,我可以毫无困难地使用roxygen2.在后一种情况下,*.RD文件和帮助页面会按预期自动生成.

有关如何做到这一点的任何提示？

Answer 1

当然你可以做到这一点.

首先通过RStudio中的帮助器功能或通过调用创建一个包Rcpp.package.skeleton().

其次,在C++源文件中创建一个roxygen块.在GitHub上看到一百万个例子,例如我最近的一个例子.

第三个告诉Rcpp创建C++ - > R绑定:调用compileAttributes().RStudio会为你做这件事. 现在你在R中有了roxygen标记(例如这里看到的).

第四是让Roxygen处理标记.你可以在RStudio中启用它,我只需要调用(一个帮助脚本调用)roxygen2::roxygenize(".", roclets="rd").这将创建手册页

现在你有一个带有R函数的包调用C++函数.

所有这些已经在相应的Rcpp属性小插图中解释了多年.