tle: “Sistemas de ayuda dentro del entorno R/Rstudio”
thor: Angelo Santana & Carmen Nieves Hernández,
Departamento de Matemáticas, ULPGC
tput:
html_document:
toc: true
toc_depth: 3
toc_float: true

 

 

 

Sistemas de ayuda en R

 

help():

Es el comando de ayuda por excelencia. Si tecleamos en la consola:

help()

o picamos en la pestaña Help de la ventana inferior derecha de Rstudio, se nos abre en dicha ventana una página de ayuda en la que podemos elegir entre manuales, referencias y material misceláneo:

ayuda de R

Si deseamos ayuda sobre alguna función específica, nos bastará con incluir el nombre de la función en el buscador de la ayuda. Así, por ejemplo, para obtener ayuda sobre la función mean (media aritmética), escribimos mean y obtenemos el resultado que se muestra en la figura:

ayuda de R sobre la función mean

De modo alternativo, podemos teclear help(mean) o ?mean directamente en la consola:

ayuda de R sobre la función mean en la Consola




Anatomía de la ayuda de una función de R

La ayuda de R sobre cualquier función se estructura en varias secciones:

  • Description: breve descripción de lo que hace la función.
  • Usage: sintaxis de la función.
  • Arguments: explicación de los argumentos que recibe la función.
  • Value: explicación del objeto que devuelve la función. El objeto devuelto puede ser un valor, una lista, una matriz, …
  • References: bibliografía relacionada con los métodos implementados en la función.
  • See Also: funciones relacionadas.
  • Examples: esta es sin duda la sección más importante ya que muestra ejemplos efectivos del uso de la función.



Si en cualquier momento queremos regresar al menú principal de la ayuda, pinchamos en el icono que representa una casita en la ventana de ayuda.

ayuda de R




apropos()

Si queremos utilizar una función que no recordamos (o no conocemos), pero de la que sabemos (o sospechamos) que su nombre contiene el término norm, podemos utilizar apropos("norm"), que nos devuelve un listado de funciones que contienen dicho témino en su definición.

apropos("norm")
##  [1] "dlnorm"        "dnorm"         "norm"          "normalizePath"
##  [5] "plnorm"        "pnorm"         "qlnorm"        "qnorm"        
##  [9] "qqnorm"        "rlnorm"        "rnorm"




help.search()

Si, en cambio, quisiéramos saber, entre todos los paquetes que R tiene instalados en nuestro sistema, cuáles contienen funciones relacionadas, aunque sea vagamente, con el término norm podemos utilizar help.search("norm") o, de manera equivalente ??norm:

help Search



El comando help.search() admite también búsquedas sobre temas más generales:

help.search("logistic regression")
help.search("genetics")
help.search("one way analysis of variance")





RSiteSearch()

la función RSiteSearch() realiza la búsqueda en los manuales y ficheros de ayuda de la web R-project, así como en las listas de correo de R. Para ello nos lanza una página web que enlaza con http://search.r-project.org./

Normalmente deberemos refinar los criterios de búsqueda una vez que hayamos accedido a la web, ya que habitualmente devuelve un número elevado de resultados.

RSiteSearch("power in statistical tests")





Ayuda sobre los paquetes instalados en R.

Cuando se instala R, por defecto también se instala una colección de librerías o paquetes adicionales que contienen múltiples funciones. Si deseamos obtener ayuda sobre qué funciones contiene un paquete y cómo actúan podemos teclear directamente en la consola:

help(package="nombre-del-paquete")

o bien, seleccionar la pestaña packages en el menú de la ventana inferior derecha de Rstudio, y a continuación picar en el nombre del paquete que nos interese:

help Packages

Una vez seleccionado el paquete, R nos muestra la lista de funciones que contiene. Picando en cualquiera de las funciones, R muestra una ayuda sobre su sintaxis. Si, por ejemplo, seleccionamos el paquete car, obtenemos el listado de sus funciones asociadas:

Funciones del paquete Car





“Demos” de paquetes.

Muchos paquetes instalados en R (no todos) incluyen la posibilidad de ejecutar una “demo” que muestra las capacidades de las funciones que contiene. La llamada a demo() sin argumentos muestra una lista de los paquetes disponibles en el sistema que incluyen tales demostraciones:

demo()

Por ejemplo, para ver una “demo” del paquete graphics bastará con teclear en la consola:

demo("graphics")





vignette()


Una “viñeta” (vignette, que podría traducirse como sinopsis o descripción) en R es un documento pdf con información sobre algún tema específico asociado a algún paquete que se indica. No todos los paquetes contienen documentos pdf de esta clase. Puede obtenerse una lista de dichos documentos en los paquetes instalados mediante:

vignette(all=TRUE)

Por ejemplo, el paquete “psych” contiene una viñeta llamada “overview”. Para leerla ejecutamos:

vignette("overview",package="psych")

Una forma algo más cómoda de acceder a las viñetas disponibles en nuestra instalación de R es a través del uso de un navegador; el siguiente comando arranca nuestro navegador por defecto y nos muestra una colección de enlaces para acceder a las viñetas instaladas:

browseVignettes()

En muchos casos la “viñeta” es el texto de un artículo publicado en alguna revista, habitualmente el Journal of Statistical Software (http://www.jstatsoft.org/) o The R Journal (http://journal.r-project.org/), en el que se explica con cierto nivel de detalle los procedimientos estadísticos implementados en el paquete.

Señalemos por último que es posible acceder directamente a las viñetas y demos de los paquetes directamente desde Rstudio; así por ejemplo, para el paquete car que hemos visto más arriba:

Funciones del paquete Car





Sistemas de ayuda fuera del entorno R/Rstudio



Guía de referencia rápida


Una pequeña guía de referencia rápida, que contiene numerosas funciones ordenadas según su objetivo:


Listado de paquetes en CRAN ordenados por áreas de aplicación.



Búsquedas en Internet


En internet pueden encontrarse numerosos motores de búsqueda especificamente diseñados para obtener resultados sobre R:

  • rdrr.io: Información sobre paquetes y funciones de R en CRAN, Bioconductor, GitHub y R-Forge.

  • Rdocumentation: Información sobre todos los paquetes de R ordenados por área de actividad.

  • search.r-project.org: Acceso directo a diversas herramientas de búsqueda.

  • Rseek: búsqueda de funciones, código, …

  • Quick-R: métodos estadísticos con R.

  • R Graphical Manual: gráficos

  • R Graph Gallery: galería de gráficos que se pueden hacer con R y el código para obtenerlos.


Listas de Correo


Es posible inscribirse en listas de correo para solicitar (o aportar) ayuda sobre R:


Questions & Answers


Las siguientes páginas ofrecen información en forma de preguntas y respuestas planteadas por la comunidad de usuarios de R:


Búsqueda genérica


Y por último, como no, el buscador de buscadores . Normalmente introduciendo la letra R en la casilla del buscador seguida de alguna cuestión específica sobre el programa, obtendremos un montón de enlaces relacionados con nuestro problema.





Libros y revistas


useR Libros

El mercado editorial está experimentando una auténtica explosión en la publicación de libros que utilizan R de alguna forma. Cada vez son más los libros de estadística y aplicaciones que utilizan R como “programa de cabecera”. Es más, muchos de estos libros vienen acompañados de una web en la que el lector puede descargarse todos los ejemplos y actividades del libro.

Revistas

Las dos revistas siguientes suelen incluir artículos con la descripción del funcionamiento de paquetes de R, o con nuevas aplicaciones de R en el ámbito de la estadística:










© 2016 Angelo Santana, Carmen N. Hernández, Departamento de Matemáticas   ULPGC