Несколько функций в одном файле .Rd
Укороченная версия: Могу ли я эмулировать документацию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
Обновить:
@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 - это решение вызывает точно такую же сложность, название справки совпадает с первой функцией.
Возможно, это просто невозможно ...