2016-11-09 17 views
1

パッケージの中に関数の例を追加しようとしています。それは私がroxygen2を使いたいということです。私がしようと比べたとき、私はそう... roxygen2ドキュメントの終わりにして、関数のコードが 開始するまで、RパッケージのRパッケージの例

#' @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 

申し訳ありませんエラーメッセージが表示されます。原則として、それはそれは、このようなファイルを見つけることができないと言う。

しかし、私は、私がしなければならない方法を得ることはありませんそれはそれであるrks。 @exampleコマンドで見つけることができるように、関数用の新しいスクリプトを作成する必要はありますか? 私は何かがファイルパス で配線されている私の機能のスクリプトがBristowCampbell.Rと呼ばれ、そのファイルパスが /Users/Manuelito/Dropbox/CIAT/SolariradianceBC/SolariradianceBC/R/BrisowCampbell.R ですので、それはおそらくだと思いますそれが見つからない理由。しかし、とにかくエラーメッセージでは、そのファイルを見つけることができませんが、私はスクリプト内の関数を呼び出すだけだと言っている。私は、roxygen2の@exampleの使い方を理解できていないと思います。誰かが私にヒントを与えることができれば、私は喜んでいます。 (1)_any_で、あなたのパッケージで定義された関数 `BC_alt`を行います は非常に多くの マヌエル

+0

二つの質問をいただき、ありがとうございますポイントを参照、読み込み、またはハードコーディングされた完全なファイルパスで何かをしようとすると?もしそうなら、それは間違っている可能性があり、変更する必要があります。 (2) 'dontrun {}'に例をラップしてみましたか? (これはちょうどバンドエイドであろう)。 – joran

+0

私はdevtools :: document()関数を使用します。基本的に、.Rdファイルをmanディレクトリに作成し、NAMESPACEファイルをメインディレクトリに追加します。 – Crt

答えて

3

使用@examples、ない@example(それは外部ファイルに格納されたコードのためのものです)