Angenommen, ich habe eine Funktion in meinem Paket geschlossen, zum Beispiel
%Vor%Was ist der korrekte (in der offiziellen CRAN Sinne) Weg, diese Funktion zu dokumentieren? Insbesondere
roxygen2 verwenden
g und h bereitstellen
Eine Möglichkeit wäre, etwas Ähnliches wie ?family zu tun, wo Sie g() und h() im Abschnitt Value der Datei .Rd dokumentieren. Fügen Sie dann erweiterte Dokumentation über g() und h() in einem maßgeschneiderten \section{foo} hinzu, auf das Sie in den Value -Abschnittseinträgen für die beiden Funktionen zeigen.
Roxygen kann dies zwar nicht über das Argument @param tun, aber Sie sollten in der Lage sein, dies als einen beliebigen roxygen-Abschnitt zu schreiben, der zur Rd-Datei hinzugefügt werden soll. Der Value -Abschnitt kann als standardmäßiges Roxygen-Markup geschrieben werden, nur der maßgeschneiderte Abschnitt muss wörtlich eingegeben werden.
Tags und Links r roxygen2 documentation