Краткая версия. Можно ли эмулировать документацию Normal
в пакете stats
с помощью roxygen
?
Длинная версия. Я работаю над пакетом и пытаюсь сделать документацию более удобочитаемой, имея ряд функций с общими входами/параметрами, собранными под одним заголовком, который будет общей ссылкой к группе. Каждая функция должна быть доступна конечному пользователю независимо.
Я принял во внимание документацию для Normal
, которая дает ряд методов, связанных с нормальным распределением, например. stats::dnorm()
.
Когда я ищу ?dnorm
, я нахожу, что имя раздела справки Normal
, хотя Normal
не является экспортируемой функцией или объектом.
То, что я пробовал, помещает следующее в funs.R
:
##' @rdname funs
##' @name funs
##' @aliases sum1
##' @aliases prod1
##' @title Two functions
##' @param x X
##' @param y Y
##' @return sum1 returns x+y
##' \cr
##' prod1 returns x*y
##' @examples
##' sum1(3,4)
##' prod1(3,4)
##' @export
sum1 <- function(x,y) x+y
##' @export
##' @rdname funs
prod1 <- function(x,y) x*y
Затем я запустил roxygen2
выше.
Трудность заключается в том, что при запуске R CMD check
в этом минимальном пакете он обнаруживает, что пакет не может быть загружен как undefined exports: funs
.
Если я удалю строку ##' @name funs
, пакет пройдет R CMD check
, но имя раздела справки sum1
, а не funs
.
Если я добавлю следующий ниже раздел примеров:
##' @export
funs <- function(x) x
Он проходит, и я могу видеть, как отформатирована помощь, как хотелось бы, но я экспортирую бессмысленную функцию, чтобы правильно отобразить имя.
Я попробовал посмотреть в справочных файлах источника для stats
, чтобы узнать, как это было достигнуто, но они находятся в формате .Rdx
, который я не уверен, как отображать.
Кроме того, в соответствующей заметке, какая вещь Normal
?
require(stats)
getAnywhere("Normal")
> no object named 'Normal' was found
Update:
@TylerRinker - Боюсь, это было первое, что я пробовал. Это объединяет функции в один файл .Rd
, но имя связанной справки совпадает с именем первой функции, чего я пытался избежать:
##' sum
##' gives the sum
##' @param x X
##' @param y Y
##' @return sum1 returns x+y
##' @examples
##' sum1(3,4)
##' @rdname funs
##' @export
sum1 <- function(x,y) x+y
##' product
##' gives the product
##' @return prod1 returns x*y
##' @examples
##' prod1(3,4)
##' @rdname funs
##' @export
prod1 <- function(x,y) x*y
@Andrie - это решение вызывает точно такую же сложность, имя справки совпадает с именем первой функции.
Возможно, это просто невозможно...