如何记录RcppExports.R链接函数?

时间:2015-08-10 12:10:29

标签: r rcpp roxygen2

在我的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 文件被删除。我想记录这些链接功能,但不知道如何。

1 个答案:

答案 0 :(得分:4)

即。确切地说,在code.cpp文件中:

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