Wiele funkcji w jednym pliku .Rd
Krótka wersja: Czy mogę naśladować dokumentacjęNormal
w opakowaniustats
za pomocąroxygen
?
Długa wersja: Pracuję nad pakietem i starałem się, aby dokumentacja była bardziej czytelna dzięki wielu funkcjom ze wspólnymi wejściami / parametrami zebranymi pod jednym nagłówkiem, co będzie ogólnym odniesieniem do grupy. Każda funkcja powinna być nadal dostępna dla użytkownika końcowego niezależnie.
Wziąłem za inspirację dokumentację dlaNormal
co daje szereg metod związanych z normalnym rozkładem, np.stats::dnorm()
.
Kiedy szukam?dnorm
Znajduję nazwę sekcji pomocyNormal
nawet jeśliNormal
nie wydaje się być eksportowaną funkcją lub obiektem.
To, co próbowałem, to wprowadzenie do tegofuns.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
Później uciekamroxygen2
Na powyższym. Trudność polega na tym, że biegnieszR CMD check
na tym minimalnym pakiecie znajduje pakiet, którego nie można załadować jakoundefined exports: funs
. Jeśli usunę linię##' @name funs
pakiet mijaR CMD check
ale nazwa sekcji pomocy tosum1
zamiastfuns
. Jeśli dodam następujące elementy poniżej sekcji przykładów:
##' @export
funs <- function(x) x
Przechodzi i widzę pomoc sformatowaną tak, jak chciałbym, ale eksportuję bezsensowną funkcję, aby uzyskać poprawne wyświetlanie nazwy.
Próbowałem szukać w źródłowych plikach pomocystats
aby zobaczyć, jak to zostało osiągnięte, ale są.Rdx
format, którego nie wiem, jak wyświetlić.
Również w powiązanej notatce robi coś takiegojest Normal
?
require(stats)
getAnywhere("Normal")
> no object named 'Normal' was found
Aktualizacja:
@TylerRinker - Obawiam się, że to była pierwsza rzecz, której próbowałem. To łączy funkcje w jedną.Rd
plik, ale nazwa powiązanej pomocy jest taka sama jak nazwa pierwszej funkcji, a tego starałem się unikać:
##' 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 - to rozwiązanie powoduje dokładnie taką samą trudność, nazwa pomocy jest taka sama jak pierwsza funkcja.
Być może to nie jest możliwe ...