2012-05-30 18 views
34

RStudio supporta la creazione automatica di modelli di roxygen?RStudio può generare automaticamente un modello di roxygen per una funzione?

In Emacs-ESS, C-x C-o produce un modello di roxygen per una funzione. Ad esempio, sarà automagicamente convertire questo:

foo <- function(x,y) x+y 

in questo:

##' .. content for \description{} (no empty lines) .. 
##' 
##' .. content for \details{} .. 
##' @title 
##' @param x 
##' @param y 
##' @return 
##' @author David 
foo <- function(x,y) x+y 

Ha funzionalità simili esistono all'interno RStudio?

aggiornamenti

  • come del ESS 12.09-2, il comando è stato cambiato in C-c C-o C-o
  • questa caratteristica è stato suggerito di Rstudio, ma la pagina di supporto è stato rimosso.
+1

Per riferimento futuro: Gli sviluppatori RStudio sono davvero bravi a ricevere feedback e suggerimenti. Puoi sempre dare un suggerimento e esprimere la tua opinione sulle funzionalità che desideri vedere nel [sito di supporto RStudio] (http://support.rstudio.org/) – Dason

+0

[Something] (http://chat.stackoverflow.com/ trascrizione/messaggio/5009687 # 5009687) mi dice che succederà presto. –

+1

Nel mio caso, usando ESS 12.04-4, è 'C-c C-o C-o'. È anche disponibile dalla barra dei menu di EMACS tramite 'ESS' ->' Roxygen' -> 'Aggiorna/Genera template'. – dardisco

risposta

23

(Conversione @Crops commento in un risposta completa)

In RStudio v0.99 c'è una nuova opzione nel menu "Codice" per .R file: "Inserisci Roxygen Skeleton". C'è un'immagine di esso in RStudio's blog post about v0.99 preview.

Roxygen skeleton menu image from RStudio

9

Il silenzio che seguì alla tua domanda dovrebbe dirti una cosa ... La risposta, attualmente, è NO è no. Conosco molte persone che usano EMACS proprio per questo motivo, e non prenderemo in considerazione il passaggio a RStudio finché non avremo il supporto completo per il roxygen. Detto questo, c'è stata una discussione a riguardo tra gli utenti ei creatori di RStudio. Considerando tutte le cose interessanti che sono state aggiunte recentemente a RStudio, non sarei sorpreso di vederlo accadere. In effetti, penso che sia abbastanza probabile che accada. Ma non trattenere il respiro per questo, potrebbe essere una lunga attesa ...

+0

forse vale la pena eliminare questa risposta ora? (Non aggiornato ...) –

+0

@BenBolker Penso che sia un bel timestamp storico :) –

1

La mia soluzione era quella di utilizzare un expander di testo (PhraseExpress nel mio caso) per fare questo.

2

In alternativa è possibile utilizzare il pacchetto R RoxygenReady per creare Roxygen scheletri/templates Roxygen.