簡體   English   中英

使用roxygen2生成命名空間:一個小例子或模板

[英]Use roxygen2 to generate namespace: a small example or template

使用roxygen2生成namespace對我來說是全新的。 一些相關問題以及http://r-pkgs.had.co.nz/namespace.html已被多次詢問和回答。 我仍然覺得這對我來說很困難。 我絕對需要閱讀更多關於這個主題的內容。 同時,我只是想知道是否有人可以提供一個簡單的代碼示例來讓我先快速入門。

我不確定以下信息是否會有所幫助。 我在 package 中有幾個功能。 DESCRIPTION包括以下內容:

Imports: 
   dplyr, 
   ggplot2,
   survival

謝謝,

嘗試在 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文件。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM