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 e는 서면으로 실행되며 실제로는 패키지를 R CMD check (R Studio에서 "패키지 확인")으로 확인할 때마다 실행됩니다. 따라서 이러한 명령의 출력을 포함해서는 안됩니다. @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 
}