Используйте roxygen2 для создания пространства имен: небольшой пример или шаблон - PullRequest
Новая
       87

Используйте roxygen2 для создания пространства имен: небольшой пример или шаблон

0 голосов
/ 07 ноября 2019

Использование roxygen2 для генерации namespace для меня совершенно новое. На некоторые связанные вопросы задавались и отвечали несколько раз, а также http://r -pkgs.had.co.nz / namespace.html . Мне все еще трудно для меня. Я определенно должен прочитать больше на эту тему. Между тем, я просто задаюсь вопросом, может ли кто-нибудь предложить простой пример кода, чтобы быстро разобраться в нем.

Я не уверен, что следующая информация поможет. У меня есть несколько функций в пакете. DESCRIPTION включает в себя что-то вроде: 

Imports: 
   dplyr, 
   ggplot2,
   survival

Спасибо,

1 Ответ

2 голосов
/ 07 ноября 2019

Попробуйте создать функцию в папке R вашего пакета.

Что-то вроде 

#' Function to plot something
#' 
#' @param my_data a data frame
#' @param x column name for x axis
#' @param y column name for y axis
#' @export
#' @import ggplot2
#' @examples
#' plotSomething(iris, 'Sepal.Length', 'Sepal.Width') 
plotSomething <- function(my_data, x, y) {
  ggplot(my_data, aes_string(x=x, y=y)) + geom_point()
}

Ключевые слова @export и @import будут проанализированы roxygen2 и обновят файл NAMESPACE после использования devtools::document().

...