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 Handbuch des Pakets erscheinen sollen oder welche nicht?
Ich bin mir bewusst, dass das Benennen einer Funktion mit einem führenden Punkt, z. .f <- function() anstelle von f <- function() ist eine Lösung. Gibt es andere Lösungen?
Ich hatte das folgende Detail in dem ausgezeichneten Buch R-Pakete von Hadley Wickham (im Abschnitt über die Objektdokumentation) verpasst ):
@keywords keyword1 keyword2 ... fügt standardisierte Schlüsselwörter hinzu. Schlüsselwörter sind optional, müssen aber, falls vorhanden, aus einer vordefinierten Liste in file.path (R.home ("doc"), "KEYWORDS") entnommen werden.
Im Allgemeinen sind Keywords nicht so nützlich, außer für interne @ keywords. Die Verwendung des Schlüsselworts intern löscht die Funktion aus dem Paketindex und deaktiviert einige ihrer automatisierten Tests. Es ist üblich, @keywords intern für Funktionen zu verwenden, die für andere Entwickler interessant sind, die Ihr Paket erweitern, aber nicht für die meisten Benutzer.
Wenn also @keywords internal zur Dokumentation der roxygen2-Funktion hinzugefügt wird, wird die Funktion nicht im Paket manual / index angezeigt, während die Hilfeseite nach dem Laden des Pakets weiterhin zugänglich ist.
Tags und Links r package roxygen2 documentation