jueves, 19 de marzo de 2009

R: Uso de la Ayuda.

Uno de los aspectos importantes de un programa informático es que esté accesible de forma fácil el sistema de ayudas cara al usuario. Por ello, este capítulo se basa en los tipos de ayudas por consola que dispone R.

Para un acceso inmediato por consola, se debe introducir el comando siguiente:

> help()

Y se nos abrirá el archivo de ayuda que trae R donde nos explica cómo usar este comando.

De forma breve, el funcionamiento es bastante sencillo, por ejemplo, si queremos obtener ayuda de la función media (mean), introduciremos el siguiente comando:

> help(mean)

Y se nos abrirá la ayuda en la función mean, que es la media aritmética en R. Conjuntamente, podemos escribir el comando de ayuda de la siguiente forma:

> help("mean")

Se debe poner entre comillas cuando queremos obtener ayuda que no sean funciones definidas en R, por ejemplo, el carácter [, es un carácter especial en R, si lo escribimos tal como se muestra:

> help([)

R, nos dará el siguiente error:

Error: unexpected '[' en "help(["

Esto quiere decir, que no entiende el comando que hemos puesto, ya que no es una función definida en R, para subsanarlo, debemos escribirlo entre comillas:

> help("[")

Y se nos abrirá la información sobre dicho carácter, al igual pasa si queremos obtener información sobre alguna de las sentencias de control: for, while, if, etc.

Un método equivalente para obtener la misma ayuda por consola es poner delante del comando o función en cuestión, el signo de interrogación: ?

Por ejemplo, para obtener ayuda sobre la función de media aritmética:

> ?mean

Se nos abrirá nuevamente la ventana de ayuda sobre dicha función. Al igual que antes, para obtener información sobre comandos o carácteres especiales de R que no sean funciones, debemos escribirlo entre comillas dobles tal y como sigue:

> ?"["

Así, obtendríamos la información del carácter especial [.

Otro tipo de ayuda bastante útil que R dispone, es saber que funciones están relacionadas con la queremos obtener información, para ello debemos escribir el siguiente comando:

> apropos("Función_de_Ayuda")

Por ejemplo, si queremos ver las funciones relacionadas con la función de media aritmética (mean), introduciremos el siguiente comando:

> apropos("mean")

Y R nos dará por consola los datos que deseamos:

[1] "colMeans".........."kmeans" "mean"......."mean.data.frame"
[5] "mean.Date"......."mean.default"............"mean.difftime"........... "mean.POSIXct"
[9] "mean.POSIXlt" "rowMeans"................"weighted.mean"

Otro tipo de ayuda que ofrece R, es la de formato en HTML, para abrir dicha ayuda, debemos introducir el siguiente comando:

> help.start()

Y se nos abrirá la ayuda en el navegador en formato HTML, y por último, para obtener información sobre objetos o funciones que tengan un título en concreto, por ejemplo la media aritmética (mean), debemos introducir el siguiente comando:

> help.search("mean")

Y se nos abrirá una ventana de script con todo aquello que tenga o esté relacionado, en este caso, con la palabra cñave de búsqueda: mean.


Como tabla resumen de comandos para obtener ayudas en R, se ilustra en la siguiente tabla:

Ayudas en R.
help()
Se abre la ventana de ayuda.
help(rnorm)
Se muestra en la ventana de ayuda información de funciones definidas en R.
help("for")
Se muestra en la ventana de ayuda información de caracteres especiales que no sean funciones.
?mean
Se muestra en la ventana de ayuda información de funciones definidas en R.
?"["
Se muestra en la ventana de ayuda información de caracteres especiales que no sean funciones.
apropos("rnorm")
Muestra las funciones relacionadas con la función de la palabra clave.
help.start()
Abre el manual de ayuda en formato HTML en el navegador web.
help.search("rnorm")
Busca ayuda sobre objetos o funciones que tengan nombre o título que contenga la cadena clave a buscar, en este caso: rnorm.

En definitiva, el manejo de la ayuda es básico para comprender y ahorrar tiempo a problemas que se nos pueda presentar en un futuro manejando R, es por ello que es muy recomendable que se familiarice con esta herramienta haciendo prácticas, como por ejemplo, las que se han ido presentando en este capítulo.

0 comentarios: