使用roxygen2生成命名空间：一个小例子或模板

Question

使用roxygen2生成namespace对我来说是全新的。 一些相关问题以及http://r-pkgs.had.co.nz/namespace.html已被多次询问和回答。 我仍然觉得这对我来说很困难。 我绝对需要阅读更多关于这个主题的内容。 同时，我只是想知道是否有人可以提供一个简单的代码示例来让我先快速入门。

我不确定以下信息是否会有所帮助。 我在 package 中有几个功能。 DESCRIPTION包括以下内容：

Imports: 
   dplyr, 
   ggplot2,
   survival

谢谢，

Answer 1

尝试在 package 的 R 文件夹中创建 function。

就像是

#' 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解析，并在使用devtools::document()后更新NAMESPACE文件。