RCPP在两个功能之间共享相同的氧

时间:2019-05-22 11:30:38

标签: r rcpp roxygen2 roxygen rcpp11

请考虑以下功能:

//' Provides some stuff AB
//' @param a integer that responsible for stuff A
//' @param b integer that responsible for stuff B
//' @export
// [[Rcpp::export]]
NumericVector foo1(int a, int b)
{
   //some code
}

//' Provides some stuff AC
//' @param a integer that responsible for stuff A
//' @param c integer that responsible for stuff C
//' @export
// [[Rcpp::export]]
NumericVector foo2(int a, int c)
{
   //some code
}

请注意,参数foo1和foo2的参数说明 a 应该相同。我有许多功能,应该以相同的方式提供 a 参数描述。我不想每次我分别为每个功能都需要复制 a 参数的描述时。是否可以指定 a 描述代码并将其应用于Rcpp软件包提供的所有功能?

将非常感谢您的帮助!

1 个答案:

答案 0 :(得分:0)

多亏了Dirk Eddelbuettel,我找到了答案:

//' @name sharable
//' @rdname sharable
//' @param a integer that responsible for stuff A
//' @export

//' Provides some stuff AB
//' @rdname sharable
//' @param b integer that responsible for stuff B
//' @export
// [[Rcpp::export]]
NumericVector foo1(int a, int b)
{
   //some code
}

//' Provides some stuff AC
//' @rdname sharable
//' @param c integer that responsible for stuff C
//' @export
// [[Rcpp::export]]
NumericVector foo2(int a, int c)
{
   //some code
}