Использование roxygen2 для функций R в пакете R, содержащем код R / Cpp
У меня есть функция Cpp, которая вызывается внутри функции R с помощью Rcpp packgae. Функция R принимает inputDataFrame и использует функцию Cpp (также принимает DataFrame) для расчета количества лекарств (A1) как функция времени. R затем возвращает inputDataFrame с добавленным столбцом для рассчитанных сумм A1,
Я хочу документировать функции R (а не функции Cpp), используя roxygen2 пакет в RStudio. Тем не менее, когда я использовал roxygen2 комментарии (как показано ниже), он не генерировал файлы * .RD и страницы справки, как вы ожидали сделать при построении модели. Обратите внимание, что у меня нет проблем с использованием roxygen2, когда мой пакет содержит только функции R. В последнем случае *.RD файлы и страницы справки генерируются автоматически, как и ожидалось.
Любые советы о том, как это сделать?
Решение
Конечно, вы можете сделать это.
Первый создать пакет, либо с помощью вспомогательной функции в RStudio, либо по телефону Rcpp.package.skeleton(),
второй создайте блок roxygen в вашем исходном файле C ++. Смотрите миллион примеров на GitHub, например: этот недавний пример один из моих.
В третьих скажите Rcpp создать привязки C ++ -> R: call compileAttributes(), RStudio сделает это для вас. Теперь у вас есть разметка roxygen в R (как например видел здесь).
четвертый У Roxygen обработать разметку. Вы можете включить это в RStudio, я просто звоню (вызов вспомогательного скрипта) roxygen2::roxygenize(".", roclets="rd"), Это создать страница руководства
И теперь у вас есть пакет с функцией R, вызывающей функцию C ++.
И все это объяснялось годами соответствующая виньетка атрибутов Rcpp.
Другие решения
Других решений пока нет …