Nuestra primer función!

#* Devuelve la suma de dos numeros
#* @get /sum
#' @param a:numeric El primer numero
#' @param b:numeric El segundo numero
function(a, b) {
    as.numeric(a) + as.numeric(b)
}

Es tan solo una suma, pero representa la base de cualquier cosa que deseemos realizar. Aquí lo importante es recordar que no es necesario que la función contenga todo la lógica, sino que nos podemos apoyar en crear otros archivos .R y ‘sourcearlos’. Para esto, tenemos que agregar source() al inicio, luego de cargar las librerías. Es importante no hacerlo dentro de la función, porque sino estaremos cargando el archivo cada vez que una persona haga un request a la función en cuestión, algo que no será para nada performante!

Qué saldrá de sumar 1.3 y 2? Veámosolo! https://demo-api.hasselpunk.com/sum?a=1.3&b=2

Un informe con parámetros y elementos dinámicos…

Si todos los días nos piden que armemos un informe y el mismo se puede parametrizar, entonces esto les va a encantar: podemos armar un archivo .Rmd y luego exponerlo como una función!

#* Informe en HTML
#* @get /html
#' @serializer contentType list(type="application/html; charset=utf-8")
#' @param stock:character Ticker obtenido desde Yahoo Finance
function(res, stock="BTC-USD"){
  f <- rmarkdown::render("InformeHTML.Rmd", 
                         output_format = NULL,
                         params = list(stock = stock))
  include_html(f, res)
}

Aquí hay algo curioso a tener en cuenta: utilizar la función nativa plumber::include_rmd() para renderizar el .Rmd no tendrá mucho sentido, ya que la misma no pasa los argumentos de los parámetros que podamos usar con Rmd…. pero aquí viene un gran consejo de Hadley Wickham: usar F2. Esto es: hacer click en la función y luego en F2 para ver su código fuente! De esta manera veremos cómo está implementado, y a lo sumo podremos hacer los cambios necesarios según nuestra conveniencia.

Vemos que no hay mucha diferencia entre la función de plumber y mi función, ambas usan include_html(), pero mi código pasa los parámetros dentro de render():

function (file, res, format = NULL) 
{
  requireRmd("include_rmd")
  f <- rmarkdown::render(file, format, quiet = TRUE)
  include_html(f, res)
}

El resultado es un método al cual se le puede pasar el nombre del ticker (sigla que tienen los instrumentos financieros y los pueden buscar en yahoo finance) y generará un sitio con un informe en HTML. Veamos cóm ha evolucionado la cotización de la Bolsa de Buenos Aires o de Tesla.

Pueden probar buscar ustedes mismos otros productos financieros y armar sus informes respetando la siguiente estructura https://demo-api.hasselpunk.com/html?stock=TSLA

Un informe con parámetros en PDF

Quizás un informe con elementos dinámicos no sea la mejor opción para quienes desean imprimirlo, es por esto que también creamos un informe pero en PDF:

#* Informe en PDF
#* @get /pdf
#' @serializer contentType list(type="application/pdf; charset=utf-8")
#' @param stock:character  Ticker obtenido desde Yahoo Finance
function(res, stock="BTC-USD"){
  temp <- tempfile(fileext = ".pdf")
  rmarkdown::render("InformePDF.Rmd", 
                    output_file = temp,
                    output_format = NULL,
                    params = list(stock = stock))
  readBin(temp,'raw', n = file.info(temp)$size)
}

Esta secuencia me ha llevado un tiempo pero finalmente logré darme cuenta que:

1. Hay que generar un archivo temporal con extensión .pdf
2. Luego debemos guardar el pdf renderizado en el archivo temporal que hemos creado
3. Finalmente leeremos este archivo temporal.

Con estos pasos lograremos generar un PDF que se podrá ver en el navegador. Veamos como fue la evolución del Bitcoin en los últimos 6 meses: https://demo-api.hasselpunk.com/pdf?stock=BTC-USD

Es muy importante usar @serializer para mostrar cual es el tipo de contenido con el que estamos trabajando.