testthat .Rbuildignore + внешний файл (ПРИМЕЧАНИЕ)

Question

Сборка пакета с использованием testthat для тестов; те требуют внешнего файла, который в соответствии с рекомендациями лежит в /tests/testthat/my-file,

Тем не менее R CMD check производит

Found the following hidden files and directories:
  tests/testthat/my-file

Выше ПРИМЕЧАНИЕ (Status: 1 NOTE)

Если я добавлю мой файл в .Rbuildignore (devtools::use_build_ignore("/tests/testthat/my-file") тогда файл исправен, игнорируется во время проверки, поэтому все тесты не пройдены, и пакет не может быть собран.

Как я могу решить эту проблему? Я понимаю что NOTE это сносно, но я хотел бы избавиться от этого, тем не менее.

Answer 1

Согласно Хэдли, предпочтительным способом загрузки учетных данных API является использование переменных среды. Если вы предоставляете учетные данные в своем пакете, вы можете просто установить их в .onLoad загружена функция, которая будет запускаться с пространством имен пакета. Если вы просто хотите иметь возможность запускать тесты локально с использованием этих учетных данных, но не делиться ими, то добавьте их в глобальный Renviron.site файл (или, что менее удобно, в .Renviron файл в вашем рабочем каталоге). Затем вы можете удалить этот файл из структуры вашего пакета (или просто.Rbuildignore его) и сделать тесты обусловленными наличием переменной окружения, например:

if (!identical(Sys.getenv("MY_ENV_VAR"), "")) {
  test_all("package")
}