如何记录 RcppExports.R 链接功能？答案

【问题标题】：How to document RcppExports.R linking functions?如何记录 RcppExports.R 链接功能？
【发布时间】：2015-08-10 12:10:28
【问题描述】：

在我的RcppExports.R 中，情况如下所示：

# This file was generated by Rcpp::compileAttributes
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

rcppeigen_ftrans <- function(A) {
    .Call('mypkg_rcppeigen_ftrans', PACKAGE = 'mypkg', A)
}

我尝试这样记录我的代码：

# This file was generated by Rcpp::compileAttributes
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
# 
#' Fast Matrix Transpose
#' 
#' (description)
#' @param ...
#'

rcppeigen_ftrans <- function(A) {
    .Call('mypkg_rcppeigen_ftrans', PACKAGE = 'mypkg', A)
}

每当我点击document 按钮时，roxygen2 就会自动运行 Rcpp::compileAttributes() 然后重新生成此文件文档。我也试过手动写 .Rd 文档文件，但是当我再次点击 document 时，.Rd 文件被删除。我想记录这些链接功能，但不知道如何。

【问题讨论】：

将 roxygen 文档放入源 Cpp 文件中。
@hadley 一如既往的天才！非常感谢！
伙计们，有超过 430 个包在 CRAN 上使用 Rcpp。 这些是工作示例。使用它们。此外，搜索是此处顶部的搜索框，[r] [rcpp] [roxygen] 几乎肯定会提供提示。

标签： r rcpp roxygen2

【解决方案1】：

即准确地说，在您的code.cpp 文件中：

//' Fast Matrix Transpose
//' 
//' Description
//' @param m
//' ... etc
IntegerMatrix fasttr(IntegerMatrix m) {

【讨论】：