用于 R 包的 Roxygen 示例

Question

我正在尝试在我的程序包中添加一个函数示例。那是因为我想使用 roxygen2。我正在做以下事情（只是我的代码的一部分，在 roxygen2 文档的末尾，直到函数的代码开始 ...

#' @import  EcoHydRology
#' @export
#' @example
#' Tx <- 29
#' Tn <- 13
#' rain <- 100
#' lat <- 1
#' Ion <- 10
#' DOY <- 44
#' z <- 450
#' c <- 2.4
#' B <- 0.004
#'
#' BC_alt(Tx, Tn, rain, lat, lon, DOY, z, c, B)



BC_alt <- function(Tx, Tn, rain, lat, lon, DOY, z, c, B){



  #Extraterrestrial solar radiation (with EcoHydRology package)
  lat_rad <- lat*pi/180

  A <- 0.75+(2*10^(-5)*z)

... 因此，当我尝试构建并重新加载时，我收到一条错误消息

>     Fehler in file(con, "r") : kann Verbindung nicht öffnen
>     Ruft auf: suppressPackageStartupMessages ... process_examples -> unlist -> lapply -> FUN -> file
>     Zusätzlich: Warnmeldung:
>     In file(con, "r") :
>       kann Datei '/Users/Manuelito/Dropbox/CIAT/SolariradianceBC/SolariradianceBC/Tx <-
> 29
>     Tn <- 13
>     rain <- 100
>     lat <- 1
>     Ion <- 10
>     DOY <- 44
>     z <- 450
>     c <- 2.4
>     B <- 0.004
>     
>     BC_alt(Tx, Tn, rain, lat, lon, DOY, z, c, B)' nicht öffnen: No such file or directory

抱歉，部分内容为德语。主要是它说找不到这样的文件。

但我不知道我必须怎么做才能让它起作用。我是否必须为该函数创建一个新脚本以便@example 命令可以找到它？我认为某些东西与文件路径有关我函数的脚本名为 BristowCampbell.R，其文件路径为 /Users/Manuelito/Dropbox/CIAT/SolariradianceBC/SolariradianceBC/R/BrisowCampbell.R 所以这可能就是它找不到它的原因。但无论如何，在错误消息中它说找不到文件，但我只是在脚本中调用一个函数。我想我有点不明白如何使用 roxygen2 中的@example。如果有人能给我提示，我会很高兴。非常感谢曼纽尔

Answer 1

使用 @examples，而不是 @example（它适用于存储在外部文件中的代码）

用于 R 包的 Roxygen 示例

Example with Roxygen for R Package

r

roxygen2