3.1 Buscando ayuda

Por sí mismo, R cuenta con funciones que nos permitirán obtener ayuda sobre R en general pero también sobre las diferentes funciones que estemos usando para resolver algún problema.

Para mostrar un manual de ayuda general en formato HTML corremos el siguiente código en la consola:

help.start()

El manual será mostrado en el panel de ayuda dentro de RStudio pero puede abrirse con el navegador en caso de que así lo deseemos.

Supongamos ahora que dentro de nuestro flujo de trabajo estamos utilizando la funcíón log() sin embargo no estamos familiarizados con ella y deseamos obtener ayuda sobre el uso de la función.

Para a tener acceso a la documentación de la función podemos usar alguna de las siguientes líneas de código:

help(log)
?log

En el caso particular de RStudio, existe un atajo con el que podemos abrir la documentación de cualquier función sin necesidad de correr alguna de las líneas anteriores en la consola.

El atajo consiste de colocar el cursor de texto entre cualesquiera caractéres de la función y presionar el botón F1 de nuestro teclado.

Adicionalmente tenemos las siguientes funciones:

apropos("plot")
help.search("plot")

apropos() nos ayudará a encontrar las funciones que incluyan el texto (en este caso plot) en su nombre.

Por otro lado, help.search() nos mostrará la documentación de las funciones que incluyan el texto, en este caso plot.

Como se indica, cualquiera de esas opciones te permitirá tener acceso a la documentación de la funciones donde podrás encontrar: para qué se usan, qué argumentos necesitan, lo que regresan y algunos ejemplos del uso de las mismas. En el caso de buscar información sobre algún paquete instalado, se pueden usar los comandos vignette(package = "some_package") o vignette("some_package"), al igual que ?library.

Algunas veces, una buena opción será consultar información creada por diferentes autores. La siguiente es una lista de varios Bookdowns que les pueden ser de gran utilidad y de constante consulta. Al final también se agrega la liga oficial para consultar las CheatSheets disponibles.

Una buena parte de los errores que podamos encontrarnos en nuestros flujos de trabajo se resolverán al revisar la documentación de la función que esté generando el error, sin embargo habrá ocasiones en las que los errores sean más complejos y la documentación no nos dará una buena pista de cómo remediarlos, en tal caso la mejor estrategia sera utilizar tu buscador favorito para buscar el error.

Será tan fácil cómo copiar el error que la consola esté arrojando y ponerlo en la barra de búsqueda de e.g. Google. Muchas veces las soluciones las encontrarás en Stack Overflow o en otros medios; por ejemplo, para un problema relacionado a la estadística bien podrías encontrar información valiosa en Cross Validated.