inst/doc/distilleR.R

## ----include=FALSE------------------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

## ----eval=FALSE---------------------------------------------------------------
# install.packages("distilleR")

## ----eval=FALSE---------------------------------------------------------------
# # install.packages("devtools")
# devtools::install_github("openefsa/distilleR")

## ----apiKeyExample, eval=FALSE------------------------------------------------
# token <- getAuthenticationToken(distillerKey = "<your_distiller_api_key>")

## ----instanceUrlExample1, eval=FALSE------------------------------------------
# token <- getAuthenticationToken(
#   distillerKey = "<your_distiller_api_key>",
#   distillerInstanceUrl = "<your_distiller_instance_url>"
# )

## ----instanceUrlExample2, eval=FALSE------------------------------------------
# projects <- getProjects(
#   token = token,
#   distillerInstanceUrl = "<your_distiller_instance_url>"
# )

## ----loadLibrary, eval=FALSE--------------------------------------------------
# library(distilleR)

## ----eval=FALSE---------------------------------------------------------------
# help("<function_name>")

## ----eval=FALSE---------------------------------------------------------------
# help("getReport")

## ----tokenSetup, eval=FALSE---------------------------------------------------
# token <- getAuthenticationToken()

## ----projectsList, eval=FALSE-------------------------------------------------
# projects <- getProjects(distillerToken = token)
# 
# print(projects)

## ----reportsList, eval=FALSE--------------------------------------------------
# reports <- getReports(projectId = 1234, distillerToken = token)
# 
# print(reports)

## ----getReport, eval=FALSE----------------------------------------------------
# projectId_ <- 1234
# reportId_ <- 567
# 
# report <- getReport(
#   projectId = projectId_,
#   reportId = reportId_,
#   format = "excel",
#   distillerToken = token)
# 
# print(head(report))

Try the distilleR package in your browser

Any scripts or data that you put into this service are public.

distilleR documentation built on April 24, 2026, 1:07 a.m.