用于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(它用于存储在外部文件中的代码)