Ich verwende das Paket devtools , um zu prüfen, ob ein Paket, das ich gerade entwickle, für die Einreichung bei CRAN bereit ist.
Mit Roxygen2 bis devtools habe ich eine kleine Anzahl von Funktionen mit #'@export dokumentiert, damit sie verfügbar sind, wenn das zu entwickelnde Paket geladen wird.
Wenn ich jedoch devtools::check() ausführe, muss ich die Funktionen protokollieren, die NICHT exportiert werden, dh diejenigen, die von einer Funktion aufgerufen werden, die exportiert wird, die aber für das Paket nicht verfügbar oder erforderlich ist . Hier ist ein Beispiel aus der Ausgabe von devtools::check() :
Muss ich diese Argumente dokumentieren, obwohl die Funktion nicht exportiert wird?
Ich glaube, dass das Problem hier (basierend auf früheren Erfahrungen) darin besteht, dass Sie wahrscheinlich in der Präambel der Funktion Roxygen-Kommentartrennzeichen #' verwenden. Dies (ich bin mir ziemlich sicher) löst die Erstellung einer .Rd -Datei aus (und die Notwendigkeit, Parameter zu dokumentieren), unabhängig davon, ob Sie eine @export -Direktive haben oder nicht. Meine Lösung in diesem Fall war die Verwendung von # commenting anstatt #' .
Basiert auf diese Antwort Es ist möglich, dass eine explizite @keywords internal Direktive auch funktionieren würde (aber ich habe es nicht versucht).