7 AYUDAS

Para acceder a la ayuda sobre cualquier función, se escribe ?función o help(función). Así, para obtener ayuda, por ejemplo, para la función read.table, se escribe ?read.table o help(read.table). La función sobre la que se busque ayuda por esta vía debe formar parte de un paquete instalado y cargado (cf. secciones 4.1 y 4.2).

También puede buscarse ayuda escribiendo el nombre de la función en el botón de búsqueda de la pestaña “Help”, la cual se ubica por defecto en el panel inferior derecho de RStudio, y a la que puede accederse directamente pulsando Ctrl + 3.

Las ayudas para todas las funciones en R tienen un formato común, conformado por varias secciones, las cuales se ilustran a continuación, tomando como referencia la función binom.test.

1. Nombre de la función y del paquete del cual forma parte. En R, todas las funciones se encuentran dentro de algún paquete. Para indicar cuál es el paquete que contiene la función, este se escribe al final, dentro de llaves.

    binom.test {stats}

2. Nombre largo de la función. La mayoría de las funciones tienen nombres cortos que, aunque facilitan su uso, en ocasiones no dan mucha información sobre la función. Esta información aparece en el título o nombre largo de la función.

   Exact Binomial Test

3. Descripción de la tarea realizada. En esta sección se indica, usualmente mediante una oración, la tarea que es ejecutada por la función.

4. Sintaxis (Usage). Esta es una de las partes más importantes de las ayudas, pues allí aparecen explícitamente el nombre y la posición de los argumentos utilizados por la función. Puede verse, por ejemplo, que la función binom.test tiene cinco argumentos, el orden de los mismos y los valores por defecto o admitidos de algunos de estos.

   binom.test(x, n, p = 0.5, alternative = c("two.sided", "less", "greater"), conf.level = 0.95)

   Los argumentos que no traen ningún valor (v. gr. x y n) son obligatorios. Se requiere que el usuario suministre tales valores para que la función pueda ejecutarse. En ocasiones se muestra un listado de valores, como en el caso del argumento alternative, que indican las opciones válidas para dicho argumento. Cuando el argumento aparece con un único valor (v. gr. conf.level = 0.95), dicho valor es el que se usaría por defecto.

5. Argumentos. En esta sección se detallan las características y funcionalidad de cada uno de los argumentos que aparecen en la sección anterior.

6. Detalles. Cuando el autor considera necesario detallar algunas características de la función, puede incluir esta sección.

7. Resultados generados (Value). En esta parte se muestran todos los resultados generados por la función, tanto los explícitos, como algunos otros que permanecen ocultos para el usuario, pero que estarían disponibles si este los solicita.

8. Fuente (Source). Algunas funciones provienen de la adaptación de algoritmos escritos inicialmente en otros lenguajes. Cuando este es el caso, en esta sección se cita la fuente original.

9. Autor. Aunque en muchas ocasiones no aparece esta sección, casi siempre es posible conocer el autor y, eventualmente contactarlo, en caso de necesidad, revisando las ayudas del paquete.

10. Referencias. Artículos o libros en los que se presenta el tema programado en la función.

11. Funciones relacionadas (See also). Aparece el vínculo a otras funciones que realizan tareas similares.

12. Ejemplos. Puede ser una de las secciones de mayor utilidad. Los ejemplos que se presentan en esta sección tienen la ventaja de que siempre ejecutan adecuadamente, sin depender de datos externos. Para tal efecto, basta con copiar el correspondiente conjunto de instrucciones, bien sea en el editor de scripts o en la consola, y ejecutarlos¹⁷.

Si no se recuerda el nombre exacto de una función o se desea buscar funciones con nombres similares, puede usarse la función apropos, la cual da como resultado un listado de las funciones cuyo nombre incluye la cadena de caracteres en cuestión. Debe tenerse en cuenta, sin embargo, que la búsqueda solo se realiza dentro de los paquetes cargados en memoria (cf. sección 4.2).

apropos("read")
#>  [1] "read.csv"         "read.csv2"        "read.dcf"         "read.delim"      
#>  [5] "read.delim2"      "read.DIF"         "read.fortran"     "read.ftable"     
#>  [9] "read.fwf"         "read.socket"      "read.table"       "readBin"         
#> [13] "readChar"         "readCitationFile" "readClipboard"    "readline"        
#> [17] "readLines"        "readRDS"          "readRegistry"     "readRenviron"    
#> [21] "Sys.readlink"

Muchos paquetes incluyen viñetas, esto es, archivos formato pdf en los que se desarrollan ampliamente las particularidades del paquete en cuestión. Aunque es posible ubicar manualmente tales archivos en la carpeta “doc”, dentro de la carpeta cuyo nombre corresponde con el del paquete y que se encuentra, a su vez, dentro de la carpeta “library”, tales archivos son más fácilmente ubicables invocando las ayudas del paquete con doble signo de interrogación, o equivalentemente mediante la función help.search.

??'agricolae'

o

help.search('agricolae')

El paquete agricolae incluye un tutorial en pdf, al que puede accederse por esta vía.

La función help.search también puede utilizarse para buscar información sobre algún tema específico, dentro de los paquetes instalados¹⁸.

help.search('correspondence')

Si se busca ayuda sobre símbolos especiales, tales como los operadores, o sobre comandos reservados, estos deben escribirse entrecomillados.

?"+"

o

help("if")

En Internet existe gran cantidad de recursos sobre R. Para acceder a los mismos, basta con realizar la correspondiente búsqueda, bien sea a través de un buscador genérico como Google o a través del buscador específico R Seek.

Aunque eventualmente podrían encontrarse algunas ayudas en español, la mayoría está en inglés, por lo cual se recomienda usar este idioma en todas las búsquedas.

Un sitio que merece una mención especial es Stack Overflow, el cual, tal y como reza su descripción en Wikipedia aloja preguntas y respuestas para programadores entusiastas y profesionales. Es bastante común que las consultas realizadas mediante cualquier buscador genérico conduzcan a este sitio. A quienes migran desde SAS, SPSS y Stata, el sitio Quick-R puede facilitarles dicha transición. De igual manera, los textos de Muenchen (2009) y de Kleinman y Horton (2010) también presentan paralelos que les facilitan la migración a usuarios de otros programas.