Jak wskazać kolejność sortowania w Roxygen2?

Używanie dokumentacji roxygen2 z devtools document funkcja automatycznie generuje pole Collate: w OPISIE PAKIETU, niezależnie od tego, czy konieczne jest załadowanie plików biblioteki paczek w określonej kolejności.Jak wskazać kolejność sortowania w Roxygen2?

Pracuję nad pakietem z wiązką metod S4 i chcę mieć pewność, że definicje klas są ładowane przed metodami lub innymi klasami z nich korzystającymi, co rozumiem, że mogę zrobić z listą Collate, ale ja ' m nie wiem, jak to wskazać w formacie dokumentacji roxygen2.

Odwołanie roxygen2 manual odnosi się do znacznika @include, ale wygląda na to, że może zawierać kod w dokumentacji, na przykład w celu dodania przykładów zewnętrznych za pomocą flagi @examples. Czy można to wykorzystać do określenia kolejności sortowania dla metod?

Źródło

2013-08-31 cboettig

Jeśli sortowania pole jest już w OPISU roxygen2 nie generuje go. Powiedziałbym więc, że musisz zrobić zamówienie, które chcesz i powinno być szanowane. (Myślę, stąd komentarz do odpowiedzi). –

Byłoby miło wiedzieć, czy moja interpretacja @import jest poprawna. Z pewnością dobrze byłoby, gdyby funkcja obliczała kolejność sortowania z listy zależności plików, a nie ręcznie. – cboettig

import służy do importowania pakietu. Jest to podobne do wymieniania pakietu w sekcji Depends, z tym że jest znacznie czystszy, ponieważ nie zanieczyszcza przestrzeni nazw użytkownika. – Dason

Znacznik include służy do stwierdzenia, że jeden plik wymaga innego. (Nazwa może nie być najlepszym wyborem, ale takie jest życie). Jeśli chcesz się upewnić, że plik B zostanie wczytany przed plikiem A, upewnij się, że w przypadku A. Roxygen zajmie się uporządkowaniem pola sortowania w celu spełnienia ograniczeń.

Źródło

2013-09-03 14:07:23 hadley

genialny, więc zawiera to, czego potrzebuję! – cboettig

prostu zorientowali się, że jeśli dodać @include oświadczenie w górnej części pliku R, będzie to kolidować z następnego bloku dokumentacji roxygen2 chyba śledzić go z np NULL

#' @include something.R 
NULL 

#' Documenting a function 
#' 
#" It does something... 
#' 
#' @param ... 
#'

Źródło

2014-02-26 18:56:26 THK

Jak wskazać kolejność sortowania w Roxygen2?

Odpowiedz

Powiązane problemy