2012-05-30 17 views
34

¿RStudio es compatible con la creación automática de plantillas roxygen?¿Puede RStudio generar automáticamente una plantilla roxygen para una función?

En Emacs-ESS, C-x C-o producirá una plantilla de roxygen para una función. Por ejemplo, se automágicamente convertir esto:

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

en esto:

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

¿Existe una funcionalidad similar dentro rstudio?

actualizaciones

  • como de ESS 12.09-2, el comando se ha cambiado a C-c C-o C-o
  • esta característica se ha sugerido que rstudio, pero la página de soporte ha sido eliminado.
+1

Para referencia futura: Los desarrolladores de RStudio son realmente buenos para recibir comentarios y sugerencias. Siempre puede hacer una sugerencia y expresar su opinión sobre las características que desea ver en el [sitio de soporte de RStudio] (http://support.rstudio.org/) – Dason

+0

[Something] (http://chat.stackoverflow.com/ transcript/message/5009687 # 5009687) me dice que esto sucederá pronto. –

+1

En mi caso, usando ESS 12.04-4, es 'C-c C-o C-o'. También está disponible en la barra de menú de EMACS a través de 'ESS' ->' Roxygen' -> 'Actualizar/Generar plantilla'. – dardisco

Respuesta

23

(conversión de @Crops comentar en una respuesta completa)

En rstudio v0.99 hay una nueva opción en el menú "Código" para .R archivos: "Insertar Roxygen esqueleto". Hay una imagen de él en RStudio's blog post about v0.99 preview.

Roxygen skeleton menu image from RStudio

9

El silencio que siguió a su pregunta debería decirle algo ... La respuesta, actualmente, es NO no lo es. Sé de varias personas que usan EMACS precisamente por esta razón, y no consideraría cambiar a RStudio hasta que tenga soporte completo de roxygen. Dicho esto, ha habido cierta discusión sobre esto entre los usuarios y los creadores de RStudio. Teniendo en cuenta todas las cosas geniales que se han agregado a RStudio recientemente, no me sorprendería que sucediera. De hecho, creo que es bastante probable que suceda. Pero no aguante la respiración, puede ser una larga espera ...

+0

quizás valga la pena eliminar esta respuesta ahora? (Desactualizado ...) –

+0

@BenBolker Creo que es una buena marca de tiempo histórica :) –

1

Mi solución fue utilizar un expansor de texto (PhraseExpress en mi caso) para hacer esto.

2

Alternativamente, puede utilizar el paquete R RoxygenReady para crear esqueletos Roxygen/templates Roxygen.

Cuestiones relacionadas