Previzualizare dezvoltare documentație R (Programare, R, Documentație, Devtools, Roxygen2)

Servadac a intrebat.

Scriu primul meu pachet R folosind devtools și roxygen2 în IDE-ul RStudio. Problema pe care o am este legată de previzualizarea fișierelor .Rd pe care le obțin atunci când „roxygenizez” fișierele .R. Folosesc devtools::document() pentru a obține fișierele .Rd, dar când încerc să previzualizez paginile de ajutor scriind oricare dintre:

help("FunctionName")
?FunctionName

consola afișează mesajul „Using development documentation for…” (Utilizarea documentației de dezvoltare pentru…), dar în fereastra de ajutor apare un spațiu gol. Folosind devtools:load_all() provoacă aceeași problemă. Poate că acest lucru are legătură cu modul în care devtools încarcă pachetul în mediu, dar nici documentul „Writing R Extensions” (care nu este de așteptat să fie consultat pentru a utiliza roxygen), nici cartea „R packages” de Hadley Wickham nu oferă o soluție funcțională.

Comentarii

  • Funcționează după compilare? –  > Por Axeman.
  • Dacă generez documentația, construiesc fișierul .tar, îl instalez și biblioteculez pachetul, există în continuare aceeași problemă. De obicei, închid și redeschid RStudio pentru ca lucrurile să funcționeze. Cu toate acestea, aceasta este o sarcină foarte plictisitoare pentru a previzualiza doar fișierele .Rd. –  > Por Servadac.
  • @Servadac Încă mai aveți această problemă? –  > Por Dason.
  • Soluția pe care am găsit-o este Built &; Reîncărcați pachetul , cu butonul RStudio, ceea ce necesită mai mult timp și nu este la fel de util pentru depanarea codului. Când am scris această întrebare nu știam că RStudio are această capacitate. –  > Por Servadac.
1 răspunsuri
petermeissner

În Rstudio, sub opțiuni de proiect există o opțiune generarea documentației cu elementul roxygen – verificați-l.

Apoi faceți clic pe Configure… și bifați căsuțele de genul acesta:

Acum, de fiecare dată când apăsați Ctrl+Shift+B, fișierele de documentație vor fi reconstruite și le puteți parcurge făcând clic pe numele funcției și apăsând F1 sau tastând una dintre următoarele linii în consolă:

?my_function
help(my_function)