Используйте roxygen2 для экспорта функции варианта

Question

Когда я использую @describeIn или же @rdname чтобы задокументировать вариант функции, этот вариант не экспортируется. Есть ли тег, который я могу поместить в каркас кислорода, чтобы изменить это, или мне нужно идти прямо в NAMESPACE?

#' Title
#'
#' @return
#' @export
#'
#' @examples
foo <- function() {
  "foo"
}

#' @rdname foo A variant
#'
#' @export
bar <- function() foo()

Когда я прилагаю этот пакет, я могу позвонить foo просто отлично, но пытаюсь позвонить bar результаты в Error: could not find function "bar",

Answer 1

Проблема в строке текста после @rdname foo, Обратите внимание на сообщение о "неверном пути", которое выдается при запуске roxygen:

> devtools::document()
Updating mypackage documentation
Loading mypackage
Writing NAMESPACE
Writing foo.Rd
Skipping invalid path:  foo A variant..Rd 

Это можно исправить, удалив текст метки:

#' @rdname foo
#' @export

Или с помощью @describeIn:

#' @describeIn foo A variant.
#' @export