Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.

html

Crear paquetes en R
1 Introducción
1.1 Definiciones previas (Creating R Packages: a tutorial)

Package: An extension of the R base system with code, data and

documentation in standardized format.
Library: A directory containing installed packages.
Repository: A website providing packages for installation.

1.2 Definiciones previas (Creating R Packages: a tutorial)

Source: The original version of a package with human-readable text and

code.
Binary: A compiled version of a package with computer-readable text
and code, may work only on a specific platform.

1.3 Definiciones previas (Creating R Packages: a tutorial)

Base packages: Part of the R source tree, maintained by R Core.

Recommended packages: Part of every R installation, but not
necessarily maintained by R Core.
Contributed packages: All the rest.

1.4 ¿Por qué crear y publicar un paquete para R?

1. Organización
Es una herramienta cómoda para mantener colecciones
coherentes de funciones y datos.
La estructura de un paquete obliga a organizar, limpiar y
documentar el código.

1.5 ¿Por qué crear y publicar un paquete para R?

1. Colaboración
Permite publicar código de forma que pueda ser empleado por
otros siguiendo unas estructuras comunes.
Al distribuir las herramientas para que otros puedan usarlas, se
obtiene realimentación sobre lo publicado, de forma que se
aumenta su robustez, se amplian sus funcionalidades y se
conecta con otras herramientas y proyectos.

1.6 ¿Por qué crear y publicar un paquete para R?

1 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

1. Ética

«As we enjoy great advantages from the inventions of others, we should

be glad of an opportunity to serve others by any invention of ours, and
this we should do freely and generously.» (B. Franklin)

1.7 Algunos consejos genéricos

Extraído de Best Practices for Scientific Computing

Write programs for people, not computers.

Automate repetitive tasks
Use the computer to record history
Make incremental changes
Use version control
Don’t repeat yourself (or others)
Plan for mistakes
Optimize software only after it works correctly
Document design and purpose, not mechanics
Collaborate

1.8

1. Referencias    B_block
Writing R Extensions
Creating R Packages: a tutorial
R package primer
Making an R package

2 Crear un paquete en R
2.1 Estructura

Las fuentes de un paquete de R están contenidas en un directorio que

contiene al menos:

Los ficheros DESCRIPTION y NAMESPACE

Los subdirectorios:
R: código en ficheros .R
man: páginas de ayuda de las funciones, métodos y clases contenidos
en el paquete.

Esta estructura puede ser generada con package.skeleton

2.2 DESCRIPTION

El fichero DESCRIPTION contiene la información básica:

2 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

Package: pkgname
Version: 0.5-1
Date: 2004-01-01
Title: My First Collection of Functions
Authors@R: c(person("Joe", "Developer", role = c("aut", "cre"),
email = "Joe.Developer@some.domain.net"),
person("Pat", "Developer", role = "aut"),
person("A.", "User", role = "ctb",
email = "A.User@whereever.net"))
Author: Joe Developer and Pat Developer, with contributions from A. User
Maintainer: Joe Developer <Joe.Developer@some.domain.net>
Depends: R (>= 1.8.0), nlme
Suggests: MASS
Description: A short (one paragraph) description of what
the package does and why it may be useful.
License: GPL (>= 2)
URL: http://www.r-project.org, http://www.another.url

Los campos Package, Version, License, Title, Author y Maintainer son

obligatorios.
Si usa métodos S4 debe incluir Depends: methods

2.3 NAMESPACE

Rusa un sistema de gestión de espacio de nombres que permite al

autor del paquete especificar:
las variables del paquete que se exportan (y son, por tanto,
accesibles a los usuarios)
las variables que se importan de otros paquetes.
las clases y métodos S3 y S4 que deben registrarse.
Este mecanismo queda definido en el contenido del fichero NAMESPACE.

2.4 NAMESPACE

El NAMESPACE controla la estrategia de búsqueda de variables que utilizan las

funciones del paquete:

1. En primer lugar busca entre las creadas localmente (por el código de la

carpeta R/).
2. En segundo lugar busca entre las variables importadas explícitamente
de otros paquetes.
3. En tercer lugar busca en el NAMESPACE del paquete base.
4. Por último busca siguiendo el camino habitual (ver el resultado de
search())

2.5 NAMESPACE: variables

Para exportar las variables f y g:

3 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

export(f, g)

Para importar todas las variables del paquete pkgExt:

import(pkgExt)

Para importar las variables var1 y var2 del paquete pkgExt:

importFrom(pkgExt, var1, var2)

2.6 NAMESPACE: clases y métodos

Para registrar el método S3 print para la clase myClass:

S3method(print, myClass)

Para usar clases y métodos S4

import("methods")

Para registrar las clases S4 class1 y class2:

exportClasses(class1, class2)

Para registrar los métodos S4 method1 y method2:

exportMethods(method1, method2)

Para importar métodos y clases S4 de otro paquete:

importClassesFrom(package, ...)
importMethodsFrom(package, ...)

2.7 Documentación

Las páginas de ayuda de los objetos R se escriben usando el formato “R

documentation” (Rd), un lenguaje similar a LaTeX.
Es aconsejable seguir estas orientaciones: Guidelines for Rd files
Para generar el esqueleto de un fichero Rd es aconsejable usar:
prompt: genérica

4 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

promptClass y promptMethods: clases y métodos.

promptPackage:
paquete
promptData: datos
Todos los comandos disponibles están en el documento Parsing Rd files.

2.8

\name{load}
\alias{load}
\title{Reload Saved Datasets}
\description{
Reload the datasets written to a file with the function
\code{save}.
}
\usage{
load(file, envir = parent.frame())
}
\arguments{
\item{file}{a connection or a character string giving the
name of the file to load.}
\item{envir}{the environment where the data should be
loaded.}
}
\seealso{
\code{\link{save}}.
}
\examples{
## save all data
save(list = ls(), file= "all.RData")

## restore the saved values to the current environment

load("all.RData")

## restore the saved values to the workspace

load("all.RData", .GlobalEnv)
}
\keyword{file}

2.9 Ejemplos

Paquete simple: https://github.com/oscarperpinan/pkgEx

Paquete con métodos S4: https://github.com/oscarperpinan/pkgMethods

3 Publicar un paquete
3.1 Itinerario

1. Comprobar

R CMD check myPackage/

5 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

2. Construir

R CMD build myPackage/

3. Publicar (o actualizar) en un repositorio

3.2 Comprobar

Comprobar un directorio (desde línea de comandos):

R CMD check myPackage/

Comprobar un paquete ya construido (desde línea de comandos):

R CMD check myPackage.tar.gz

Esta comprobación incluye más de 20 puntos de prueba detallados en el

manual Writing R extensions.

3.3 Construir

1. Fuente o binario    B_block

Se puede construir un fichero fuente en formato tarball (independiente

de la plataforma, habitual en sistemas Unix) o en forma binaria
(dependiente de la plataforma, habitual para Windows y Mac).

2. Cómo hacerlo    B_ignoreheading

Fuente en formato tarball: el resultado es un fichero tarball
myPackage.tar.gz que se puede distribuir a cualquier sistema.

R CMD build myPackage/

Comprimido binario: el resultado es una copia comprimida de la

versión instalada del paquete: depende del sistema operativo.

R CMD INSTALL --build myPackage/

3.4 Comprobar y construir en sistemas Windows

Para paquetes sin código compilado (C, Fortran), también se puede usar
R CMD check y R CMD build en un sistema Windows.
Para generar un binario hay que usar R CMD INSTALL --build.

6 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

Es posible que haya que modificar la variables de entorno TEMP y TMP

de forma que sólo contengan caracteres ASCII.
Para paquetes con código compilado, o en caso de problemas con los
comandos anteriores, hay que usar Rtools.
Se pueden instalar fuentes tarball con (ver R installation and
administration):

install.packages(myPackage.tar.gz, type='source')

3.5 Repositorios: CRAN

El principal repositorio de paquetes estables es CRAN.

Publicar en este repositorio conlleva la aceptación de unas condiciones.

Para publicar en CRAN hay que subir el fichero fuente tarball resultado
de R CMD build mediante el formulario web https://cran.r-project.org
/submit.html siguiendo los pasos que allí se indican.
Es imprescindible haber comprobado el fichero con R CMD check --as-cran
antes de subirlo al formulario. El resultado de esta comprobación no
debe contener errores, advertencias o notas.
Más detalle en el apartado Submission de las condiciones de CRAN.

3.6 Repositorios

Otros repositorios destacables son:

GitHub (versiones de desarrollo)

R-Forge (versiones de desarrollo)
RForge (versiones de desarrollo)
Bioconductor (paquetes de bioinformática)

3.7 Repositorios: GitHub

GitHub es actualmente el repositorio de código más importante por

número de usuarios y proyectos alojados.
Documentación: Guías sobre GitHub.
Existe una aplicación de escritorio.
Emplea git para realizar control de versiones.
Recursos para aprender a usar git.
Proyectos de R en GitHub.
Instalar paquete desde GitHub:

install.packages('remotes') ## solo primera vez

library(remotes)
## https://github.com/oscarperpinan/tdr
install_github("oscarperpinan/tdr")

7 de 8 6/2/20 11:41
Crear paquetes en R https://oscarperpinan.github.io/R/Paquetes.html

Autor: Oscar Perpiñán Lamigueiro http://oscarperpinan.github.io

Created: 2019-05-22 mié 20:39
Validate

8 de 8 6/2/20 11:41