R utworzyć instrukcję odniesienia z R CMD sprawdzić

Question

Piszę pakiet R i chciałbym, aby instrukcja obsługi pdf wszystkich funkcji w pakiecie. Zauważyłem z here, że R CMD check automatycznie tworzy podręcznik odniesienia.

Here Przeczytałem, że został utworzony ręczny wpis "funkcji wymienionych w sekcji eksportu NAMESPACE".

Mój plik NAMESPACE wygląda następująco:

# Export all names 
exportPattern(".") 

# Import all packages listed as Imports or Depends 
import(
    LIM 
) 

więc pomyślałem, wszystko będzie eksportowana. Podczas R CMD check w katalogu pakietu, na samym końcu mówi:

* checking PDF version of manual ... OK 

Jednak nie znajdę podręcznik odniesienia w moim katalogu pakietu (Przypuszczam, że byłoby w inst/doc). Czego tu mi brakuje?

Edit

Jak Paweł Hiemstra wskazał, muszę .Rd pliki dokumentacji. Wszystkie funkcje i zestawy danych w moim pakiecie mają pliki .Rd w katalogu pakietu. Nadal nie mogę znaleźć pliku PDF zawierającego podręcznik referencyjny.

Answer 1

R CMD check tworzy katalog PACKAGE.RCheck. W tym katalogu można znaleźć plik PACKAGE-manual.pdf.

Answer 2

Innym sposobem jest stworzenie podręcznika odniesienia bezpośrednio za pomocą:

R CMD Rd2pdf mypackage 

gdzie mypackage to folder zawierający strukturę folderu R Kod pakietu w tym folderze man ze swoimi .Rd plików.

Z jakiegoś powodu nigdy nie dostaję podręcznika podręcznika podczas budowania lub sprawdzania w RStudio, może dlatego, że gdzieś przegapiłem ustawienie. Ale uruchamianie polecenia w ten sposób działa również dobrze.

Answer 3

Miałem ten sam problem. Wydaje się, że po kliknięciu Build lub Check in Rstudio (przy użyciu devtools), domyślnie argumenty "--no-manual" są dodawane do opcji R CMD.

że rozwiązanie to daje się ręcznie argumentów w poleceń R:

library(devtools) 

check(cleanup = FALSE,manual = TRUE,path = getwd()) 

# without running the examples 
check(cleanup = FALSE,args = c('--no-examples'),manual = TRUE,path = getwd()) 

W tym przypadku, katalog o nazwie package.Rcheck zawiera instrukcję zapakowanego-Manual.pdf

Również sprawdź wszelkie błędy na wyjściu podczas sprawdzania. Mogą występować postacie, które mogą spowodować awarię dokumentacji.

HTH