R: use el operador de tubería magrittr en un paquete escrito por usted mismo

Me gustaría usar el operador de tubería %>%introducido en el magrittrpaquete en un paquete que escribí yo mismo para encadenar dplyrtransformaciones de datos. magrittraparece como Importen el DESCRIPTIONarchivo. Después de cargar mi propio paquete y probar la función que usa el operador de tubería, aparece el siguiente mensaje de error:

Error en el nombre de la función (parámetro,: no se pudo encontrar la función "%>%"

Cambiar %>%a magrittr::%>%en el código fuente de la función tampoco ayuda porque el paquete ya no se puede construir.

Debería haber funcionado correctamente si lo hubiera magrittrincluido en Depends. Sin embargo, esto no se recomienda . En su lugar, deja magrittren Importsy añadir la siguiente línea NAMESPACE:

importFrom(magrittr,"%>%")

Sugiero la lectura de las extensiones de escritura R . Su pregunta se aborda en los párrafos 1.1.3 y 1.5.1.

Una solución adicional: use el roxygenpaquete. Está implementado como parte del devtoolspaquete. Una vez que devtoolsesté instalado, la llamada devtools::document()actualizará tu NAMESPACE. También construye automáticamente archivos .Rd con documentación, lo cual es útil.

Todo lo que hace es agregar un comentario especial en el formato #' @import packagenamea un archivo para importar todas las funciones de ese paquete, o #' @importFrom packagename functionnamepara importar una función. Puede tener tantos de estos comentarios como desee en sus archivos, por lo que puede tener un conjunto de ellos en la parte superior de cada archivo, o con cada una de sus funciones que necesite una función externa.

Luego lo ejecuta devtools::document()y analiza su código en busca de esos comentarios, y luego crea un NAMESPACEarchivo apropiado para usted. Fácil.

Ahora existe una forma más sencilla de admitir la tubería en sus paquetes. El maravilloso paquete usethistiene la función use_pipe(). Ejecuta esa función una vez y se encarga de todo. Así es como use_pipe()se describe la función en la usethisdocumentación:

¿Es necesaria la configuración para usar la tubería de magrittr internamente en su paquete y reexportarla para los usuarios de su paquete?

Agrega magrittr a "Importaciones" en DESCRIPTION

Crea R / utils-pipe.R con la plantilla de oxígeno necesaria

Suponiendo que está usando RStudio, el devtoolspaquete de Hadley , y que aparece magrittren la sección Importaciones del DESCRIPTIONarchivo, aquí hay pasos que tomé para que %>%funcionen en las funciones de mi paquete.

Primero, escriba la función foo.R:

#' Convert \code{data.frame} to \code{list}.
#' 
#' @importFrom magrittr %>%
#' @name %>%
#' @rdname pipe
#' @export
#' @param x A \code{data.frame} object.
#' @examples
#' my_result <- foo(iris)
#'
foo <- function(x) {
    x %>%
        as.list()
}

Segundo, corre devtools::document().

Tercero, corre devtools::load_all().

Se creará un archivo como este en su R/directorio y su función debería funcionar como se esperaba.