8
Ich schreibe ein R-Paket und dokumentiere alle meine Funktionen mit roxygen2. Ich möchte jedoch nicht, dass alle Funktionen im Handbuch des Pakets erscheinen. Wie kann ich angeben, welche Funktionen im Pakethandbuch erscheinen sollen oder welche nicht?Funktion aus R-Paket-Handbuch ausschließen
Ich bin mir bewusst, dass die Benennung einer Funktion mit einem führenden Punkt, z.B. .f <- function() statt f <- function() ist eine Lösung. Gibt es andere Lösungen?
Warum dokumentieren Sie sie, wenn Sie sie nicht im Handbuch haben wollen? – nrussell
Weil es sowohl für mich nützlich ist, wenn ich mich erinnere, was Funktionen tun, als auch für andere, die die "versteckten" Funktionen verwenden möchten. Ich glaube, ich habe Beispiele in anderen Paketen gesehen, wo ich die Hilfeseite der Funktion nicht finden konnte, indem ich '' function_name' 'in die Konsole schrieb, nachdem ich das Paket importiert hatte, aber ich konnte die Hilfeseite sehen, wenn ich'? Pkgname: :: Funktionsname'. Ich könnte mich jedoch falsch erinnern. –
Aber Funktionen, auf die mit ':::' zugegriffen wird, werden nicht aus Paketen exportiert - was normalerweise bedeutet, dass der Autor nicht beabsichtigt hat, dass Clients diese Funktion verwenden. Im Allgemeinen sind solche Funktionen nicht dokumentiert - z. 'Werkzeuge :::. is_ASCII'. Ich würde vermuten, dass, wenn Sie eine nicht exportierte Funktion vorfanden, die * Dokumentation * hat, höchstwahrscheinlich zuvor eine exportierte (und dokumentierte) Funktion war und aus der Liste der Exporte in einer späteren Version entfernt wurde. – nrussell