Включение библиотечного вызова в документацию функции R

Question

Кто-нибудь знает, есть ли основания не включать library(package) в package @examples?Влияет ли это на проверки каким-либо образом?
Причиной для включения этого является то, что онлайновая документация (например, вывод pkgdown) вначале не содержит library(package) и, следовательно, скопированный код дает сбой (и пользователи жалуются).Я никогда не видел никаких противопоказаний для этого.Есть ли такие?

Answer 1

Я считаю, что это было бы довольно безобидно, но это выглядит странно, потому что система помощи R настроена так, что она вам не нужна.Если вы запустите

example(foo)

, вы получите сообщение об ошибке, если пакет не подключен, а если вы запустите

example(foo, package = "mypackage")

, то убедитесь, что library(mypackage) былПозвонил.

Он также вводит в заблуждение новых пользователей (тех, кто не знает о library(mypackage)) и заставляет их думать, что его нужно вызывать чаще, чем один раз.Это может даже выглядеть так, как будто вы считаете, что это подрывает ваш авторитет.

Поэтому я бы посоветовал против этого.