Die roxygen2-Dokumentation mit devtools verwenden document function generiert automatisch ein Collate: -Feld im Paket DESCRIPTION, unabhängig davon, ob die Paketbibliotheksdateien in einer bestimmten Reihenfolge geladen werden müssen oder nicht.
Ich arbeite an einem Paket mit einer Reihe von S4-Methoden und möchte sicher sein, dass die Klassendefinitionen geladen sind, bevor irgendwelche Methoden oder andere Klassen sie benutzen, was ich mit der Collate -Liste machen kann, aber ich bin mir nicht sicher, wie ich dies im roxygen2-Dokumentationsformat angeben soll.
Das roxygen2-Handbuch macht einen Verweis auf ein @include -Tag, das aber aussieht wie es könnte eigentlich nur Code in der Dokumentation enthalten, zum Beispiel externe Beispiele durch eine @examples -Flag hinzufügen. Kann dies zur Festlegung der Sortierreihenfolge für Methoden verwendet werden?
Das include-Tag wird verwendet, um anzugeben, dass eine Datei eine andere benötigt, um zu funktionieren. (Der Name include war vielleicht nicht die beste Wahl, aber so ist das Leben). Wenn Sie sicherstellen möchten, dass Datei B vor Datei A geladen wird, stellen Sie sicher, dass @include B in A angegeben ist. Roxygen wird darauf achten, dass das Sortierfeld Ihren Einschränkungen entspricht.
Tags und Links r roxygen2 documentation-generation