Buenas,
estaba terminando el proyecto de fin de carrera y estaba mirando el paquete cluster. Dentro, a parte de las funciones y de los archivos .r y .q, me encuentro los archivos .Rd. He visto que son extensiones que explican para que sirve cada funcion o archivo, pero realmente hace esto? se ejecutan en algun momento? alguna idea?
Gracias
Hola Oriol:
Efectivamente los archivos .Rd contienen las ayudas de las funciones, métodos, datos... que contiene el paquete.
Los archivos .Rd se convierten a varios formatos en el proceso de construcción de los paquetes y se consultan cuando se pide ayuda sobre alguna función incluida en el paquete.
Más aún, a los ficheros .Rd se les pasa exhaustivas pruebas para garantizar que son coherentes con las funciones del paquete. Por ejemplo, si en un fichero R del paquete defines la función "traviesa" con dos argumentos y la ayuda dice que tiene tres, R va a protestar.
Cada función de tu paquete y cada argumento de cada una de ellas debe estar documentado. Un paquete sin documentación resultaría muy poco útil para la persona que lo usase.
Para crear los ficheros .Rd te recomiendo que uses como modelo alguno de los disponibles y empieces haciendo cambios poco a poco. Si utilizas un sistema basado en linux te recomiendo emacs, tiene un modo para edición de fichero .Rd. (Espero que no seas de vi).
Saludos.
Efectivamente los archivos .Rd contienen las ayudas de las funciones, métodos, datos... que contiene el paquete.
Los archivos .Rd se convierten a varios formatos en el proceso de construcción de los paquetes y se consultan cuando se pide ayuda sobre alguna función incluida en el paquete.
Más aún, a los ficheros .Rd se les pasa exhaustivas pruebas para garantizar que son coherentes con las funciones del paquete. Por ejemplo, si en un fichero R del paquete defines la función "traviesa" con dos argumentos y la ayuda dice que tiene tres, R va a protestar.
Cada función de tu paquete y cada argumento de cada una de ellas debe estar documentado. Un paquete sin documentación resultaría muy poco útil para la persona que lo usase.
Para crear los ficheros .Rd te recomiendo que uses como modelo alguno de los disponibles y empieces haciendo cambios poco a poco. Si utilizas un sistema basado en linux te recomiendo emacs, tiene un modo para edición de fichero .Rd. (Espero que no seas de vi).
Saludos.
Gracias por la ayuda!!
de todas maneras, si quiero hacer pruebas con el paquete que yo he creado, solo para provar si se carga dentro de R, hace galta que cree los archivos .rd ya, o despues de hacer las pruevas los puedo crear? Yo utilizo Windows, tenia pensado coger uno ya hecho e ir haciendo los nuevos. Algun editor en particular? el Tinn-R iria bien??
Gracias
de todas maneras, si quiero hacer pruebas con el paquete que yo he creado, solo para provar si se carga dentro de R, hace galta que cree los archivos .rd ya, o despues de hacer las pruevas los puedo crear? Yo utilizo Windows, tenia pensado coger uno ya hecho e ir haciendo los nuevos. Algun editor en particular? el Tinn-R iria bien??
Gracias
Hola Oriol:
El proceso de construcción de paquetes en windows es más complejo que en linux y requiere de herramientas adicionales. En cualquier caso, creo que podrás instalar el paquete sin crear los archivos .Rd.
Otra opción es crear un esqueleto de los ficheros .Rd usando la función package.skeleton que construye un esqueleto de un fichero .Rd para un paquete y la función prompt que hace lo mismo pero para una función.
Con respecto al editor, no conozco Tinn-R y prefiero no opinar. Emacs también funciona bajo windows aunque la configuración para trabajar con fichero .Rd tal vez no sea automática.
Un saludo.
El proceso de construcción de paquetes en windows es más complejo que en linux y requiere de herramientas adicionales. En cualquier caso, creo que podrás instalar el paquete sin crear los archivos .Rd.
Otra opción es crear un esqueleto de los ficheros .Rd usando la función package.skeleton que construye un esqueleto de un fichero .Rd para un paquete y la función prompt que hace lo mismo pero para una función.
Con respecto al editor, no conozco Tinn-R y prefiero no opinar. Emacs también funciona bajo windows aunque la configuración para trabajar con fichero .Rd tal vez no sea automática.
Un saludo.
Vale, muchas gracias! una última pregunta: algun buen tutorial que este en español para crear paquetes en R?? Gracias