Potrzebujesz dokumentować argumenty w funkcjach, które nie są eksportowane w pakiecie R?

Question

Używam pakietu devtools, aby sprawdzić, czy pakiet, który tworzę, jest gotowy do przesłania do CRAN.

Udokumentowałem małą liczbę funkcji za pomocą #'@export, aby były one dostępne, gdy ładowany jest pakiet, który rozwijam.

Jednak po uruchomieniu , wydaje się, że muszę udokumentować funkcje, które NIE są eksportowane, tj. Te, które mogą być wywoływane przez funkcję, która jest eksportowana, ale które nie są dostępne i potrzebne każdemu, kto używa pakietu. Oto przykład z wyjścia devtools::check():

checking Rd \usage sections ... WARNING 
Undocumented arguments in documentation object 'calculate_agreement' 
    ‘a_assign_star’ ‘a_assign’ 

Czy muszę udokumentować te argumenty, chociaż funkcja nie jest eksportowana?

Answer 1

Uważam, że problem tutaj (na podstawie wcześniejszych doświadczeń) jest, że prawdopodobnie używasz ograniczników komentarza Roxygen #' w preambule funkcji. To (jestem prawie pewien) uruchamia tworzenie pliku .Rd (i potrzeby dokumentowania parametrów), niezależnie od tego, czy masz dyrektywę @export, czy nie. Moje rozwiązanie w tym przypadku polegało na regularnym komentowaniu, a nie na #'.

Na podstawie this answer może również działać wyraźna dyrektywa @keywords internal (ale ja jej nie wypróbowałem).