“Không chạy” trong các trang trợ giúp R ​​có nghĩa là gì?

Đôi khi trên trang trợ giúp R ​​cụm từ "không chạy" xuất hiện trong các nhận xét. Kiểm tra điều này từ trang trợ giúp cho "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**)

"Không chạy" có nghĩa là gì trong mã ví dụ?

"not run" bao gồm mã không nên được thực thi trong examplehàm (ví dụ: các phần mã tốn thời gian, tương tác với người dùng, ...).

xem ví dụ ?example:

Như được trình bày chi tiết trong hướng dẫn Viết phần mở rộng R , tác giả của trang trợ giúp có thể đánh dấu các phần của ví dụ cho hai quy tắc ngoại lệ

• 'dontrun' bao gồm mã không được chạy.

• 'dontshow' bao gồm mã ẩn trên các trang trợ giúp, nhưng sẽ được chạy bởi cả công cụ kiểm tra gói và hàm 'example ()'. Điều này trước đây là 'testonly', và hình thức đó vẫn được chấp nhận.

Trong sổ tay "Viết phần mở rộng R" , trong phần về \ ví dụ {...} có nói rằng

Bạn có thể sử dụng \ dontrun {} cho văn bản chỉ được hiển thị nhưng không được chạy và \ dontshow {} cho các lệnh bổ sung để kiểm tra không được hiển thị cho người dùng, nhưng sẽ được chạy bởi example ()

Khi bạn tạo một gói thì tất cả mã trong lệnh đóng \ dontrun {} sẽ hiển thị trong trợ giúp dưới dạng

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

chỉnh sửa: Câu trả lời này là trước đó.

Điều này bổ sung \donttest{}và được lấy (nguyên văn) từ Gói R của @ hadley .

Tuy nhiên với mục đích minh họa, việc bao gồm mã gây ra lỗi thường hữu ích. \dontrun{}cho phép bạn đưa mã vào ví dụ chưa bao giờ được sử dụng. Có hai lệnh đặc biệt khác. \dontshow{}được chạy, nhưng không được hiển thị trong trang trợ giúp: điều này có thể hữu ích cho các thử nghiệm không chính thức. \donttest{}được chạy trong các ví dụ, nhưng không chạy tự động trong kiểm tra R CMD. Điều này rất hữu ích nếu bạn có các ví dụ mất nhiều thời gian để chạy. Các tùy chọn được tóm tắt dưới đây.

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

C & p từ Chương 5.4 (Tệp Tài liệu R) của cuốn PHẢI ĐỌC Tạo Gói R: Hướng dẫn của Friedrich Leisch:

Phần ví dụ phải chứa mã R có thể thực thi và tự động chạy mã là một phần của việc kiểm tra một gói. Có hai lệnh đánh dấu đặc biệt cho các ví dụ:

dontrun : Mọi thứ bên trong \ dontrun {} không được thực thi bởi các bài kiểm tra hoặc example (). Điều này rất hữu ích, ví dụ, cho các chức năng tương tác, các chức năng truy cập Internet, v.v. Đừng lạm dụng nó để giúp cuộc sống của bạn dễ dàng hơn bằng cách đưa ra các ví dụ không thể thực thi được.

Ví dụ chính tắc ở đây có thể có trong trang trợ giúp cho 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)

Nếu điều này chạy, tất nhiên nó sẽ có những tác động không mong muốn.