Rd создан без экспорта - PullRequest
Новая
       30

Rd создан без экспорта

2 голосов
/ 14 февраля 2020

Я документирую внутреннюю неэкспортированную функцию. roxygen2 создает Rd-файл, хотя в документации нет тега @export. roxygen2 создал Rd-файл для следующей документации. Что мне не хватает? 

    #' Check validity of a
    #' @param a A logical value
    arg_check_a = function(a) {
      if (!is.logical(a)) {
        stop("a must be a logical value")
      }
    }

1 Ответ

4 голосов
/ 14 февраля 2020

Используйте @noRd.

Используйте тег @noRd, чтобы предотвратить создание файлов .Rd.

Я также поклонник маркировки их #' @keywords internal, который (согласно виньеткам ):

@keywords internal полезен, поскольку он удаляет функцию из индекса документации; это полезно для функций, предназначенных, прежде всего, для других разработчиков, а не для обычных пользователей пакета.

(Большая часть этого кода взята из https://github.com/r-lib/roxygen2/issues/684)

...