R 도움말 페이지에서 "실행되지 않음"은 무엇을 의미합니까?

R 도움말 페이지에서 "실행되지 않음"은 무엇을 의미합니까?

때때로 R 도움말 페이지에 "실행되지 않음" 문구가 주석에 표시됩니다.도움말 페이지에서 "with()"를 확인하십시오.

Examples
require(stats); require(graphics)
#examples from glm:
**## Not run:** 
library(MASS)
with(anorexia, {
    anorex.1 <- glm(Postwt ~ Prewt + Treat + offset(Prewt),
                    family = gaussian)
    summary(anorex.1)
})
## End(**Not run**)

예제 코드에서 "실행되지 않음"은 무엇을 의미합니까?

"실행되지 않음"은 다음에서 실행되지 않아야 하는 코드를 포함합니다.example기능(예: 시간이 많이 걸리는 코드 부품, 사용자 상호 작용 등).

예를 참조하십시오. ?example:

수동 쓰기 R 확장에 자세히 설명되어 있듯이, 도움말 페이지 작성자는 두 가지 예외 규칙에 대한 예제의 일부를 표시할 수 있습니다.

• 'dontrun'은 실행하면 안 되는 코드를 포함합니다.

• 'donshow'는 도움말 페이지에서 보이지 않는 코드를 포함하지만 패키지 확인 도구와 'donshow' 기능에 의해 모두 실행됩니다.이전에는 '테스트 전용'이었고 해당 양식은 여전히 허용됩니다.

"R 확장자 쓰기" 매뉴얼의 \example{... 섹션라는 말이 있습니다.

\dontrun{}은(는) 표시되어야 하지만 실행되지 않아야 하는 텍스트에 사용할 수 있으며 \dontrun{}은(는) 사용자에게 표시되어서는 안 되지만 example()에 의해 실행될 테스트를 위한 추가 명령에 사용할 수 있습니다.

패키지를 빌드하면 \dontrun{} 폐쇄의 모든 코드가 도움말에 다음과 같이 표시됩니다.

## Not run:
...
## End(**Not run**)

편집: 이 답변은 이전의 답변입니다.

이것은 추가됩니다.\donttest{}그리고 @hadley의 R 패키지에서 가져온 (verbatim).

그러나 설명을 위해 오류를 유발하는 코드를 포함하는 것이 유용한 경우가 많습니다. 에서는 사용하지 않는 코드를 예제에 포함할 수 있습니다.두 가지 다른 특수 명령이 있습니다.\dontshow{} 은 실행되지만 도움말 페이지에는 표시되지 않습니다. 비공식 테스트에 유용할 수 있습니다.\donttest{} 예제에서는 실행되지만 RCMD 검사에서는 자동으로 실행되지 않습니다.실행 시간이 오래 걸리는 예제가 있는 경우 유용합니다.옵션은 아래에 요약되어 있습니다.

Command      example    help       R CMD check
\dontrun{}                 x
\dontshow{}       x                          x
\donttest{}       x        x

여기에 있는 표준 예제는 다음에 대한 도움말 페이지에 있을 수 있습니다.rm:

## Not run: 
## remove (almost) everything in the working environment.
## You will get no warning, so don't do this unless you are really sure.
rm(list = ls())

## End(Not run)

이것이 실행된다면 당연히 원하지 않는 효과가 있을 것입니다.

MUST-TO-READ 작성 R 패키지의 5.4장(R 문서 파일)의 C&p: Friedrich Leisch의 튜토리얼:

예제 섹션에는 실행 가능한 R 코드가 포함되어야 하며 코드를 자동으로 실행하는 것은 패키지 검사의 일부입니다.이 예에는 두 가지 특수 마크업 명령이 있습니다.

실행 중지:\dontrun{} 내부의 모든 것이 테스트 또는 예제()에 의해 실행되지 않습니다.이 기능은 대화형 기능, 인터넷에 액세스하는 기능 등에 유용합니다.실행할 수 없는 예를 들어 당신의 삶을 더 쉽게 만들기 위해 그것을 오용하지 마세요.

언급URL : https://stackoverflow.com/questions/1454211/what-does-not-run-mean-in-r-help-pages