RパッケージDoc（roxygen2） - 例パート - 実行例

Question

roxygen2でRパッケージを作成する方法とより詳細なドキュメントを学習しています。

#' Add together two numbers. 
#' 
#' @param x A number. 
#' @param y A number. 
#' @return The sum of \code{x} and \code{y}. 
#' @examples 
#' add(1, 1) 
#' add(10, 1) 
#' @export 

add <- function(x, y) { 
    x + y 
} 

しかし、私は結果を持っていると思いますが、私は?addを実行したときに私が得ること

Examples 

add(1, 1) 
add(10, 1) 

です：

私はどこかにオンライン私が見つけたこの非常に簡単な例を使用していますコード：

Examples 

add(1, 1) 
2 
add(10, 1) 
11 

Answer 1

@examplesセクションのコードは、b実際にはR CMD check（R Studioの "Check Package"）でパッケージをチェックするたびに実行されます。したがって、これらのコマンドの出力は含まれていてはなりません。

@SymbolixAUが書き込んしかし、あなたは例えば、コメントを追加できます。：

#' Add together two numbers. 
#' 
#' @param x A number. 
#' @param y A number. 
#' @return The sum of \code{x} and \code{y}. 
#' @examples 
#' add(1, 1) 
#' # 2 
#' 
#' add(10, 1) 
#' # 11 
#' @export 
add <- function(x, y) { 
    x + y 
} 

または多分かなりの：

#' Add together two numbers. 
#' 
#' @param x A number. 
#' @param y A number. 
#' @return The sum of \code{x} and \code{y}. 
#' @examples 
#' add(1, 1) # returns 2 
#' 
#' add(10, 1) # returns 11 
#' @export 
add <- function(x, y) { 
    x + y 
}