Package 'distilleR'

Authenticate to a DistillerSR session.

Description

Authenticates a user to a DistillerSR instance using a personal access key. The function returns a valid authentication token that can be used to access protected DistillerSR API endpoints.

Usage

getAuthenticationToken(
  distillerInstanceUrl = Sys.getenv("DISTILLER_INSTANCE_URL"),
  distillerKey = Sys.getenv("DISTILLER_API_KEY"),
  timeout = 1800
)

Arguments

distillerInstanceUrl	character (string). The base URL of the DistillerSR instance. By default: Sys.getenv("DISTILLER_INSTANCE_URL").
distillerKey	character (string). The personal access key generated in DistillerSR. By default: Sys.getenv("DISTILLER_API_KEY").
timeout	integer. The maximum number of seconds to wait for the authentication response. By default: 1800 seconds (30 minutes).

Details

By default, the personal access key and the instance URL are read from the environment variables DISTILLER_API_KEY and DISTILLER_INSTANCE_URL.

Value

A string containing a valid DistillerSR authentication token.

Examples

## Not run: 
# If 'DISTILLER_INSTANCE_URL' and 'DISTILLER_API_KEY' are defined in your
# environment (e.g. .Renviron).
distillerToken_ <- getAuthenticationToken()

# If 'distillerInstanceUrl' and 'distillerKey' are to be specified manually.
distillerToken_ <- getAuthenticationToken(
  distillerInstanceUrl = "https://url.to.distiller.instance",
  distillerKey = "YOUR_API_KEY")

## End(Not run)

---

Get the list of the Distiller projects associated to the authenticated user.

Description

This function queries the DistillerSR API to retrieve the list of projects accessible to the authenticated user. It requires an authentication token and a valid API instance URL. The result is a dataframe listing available projects.

Usage

getProjects(
  distillerInstanceUrl = Sys.getenv("DISTILLER_INSTANCE_URL"),
  distillerToken,
  timeout = 1800
)

Arguments

distillerInstanceUrl	character (string). The distiller instance URL. By default: Sys.getenv("DISTILLER_INSTANCE_URL").
distillerToken	character (string). The token the user gets once authenticated.
timeout	integer. The maximum number of seconds to wait for the response. By default: 1800 seconds (30 minutes).

Value

A tibble with four columns:

• id: The project ID.

• name: The name of the project.

• de_project_id.

• is_hidden.

See Also

getAuthenticationToken

Examples

## Not run: 
distillerToken_ <- getAuthenticationToken()

projects_ <- getProjects(distillerToken = distillerToken_)

## End(Not run)

---

Get a Distiller report associated to a project of the authenticated user.

Description

This function queries the DistillerSR API to retrieve a saved report associated with a given project ID. It requires user authentication and a valid API endpoint URL. The result is a dataframe containing metadata about the saved report.

Usage

getReport(
  projectId,
  reportId,
  format = c("excel", "csv"),
  distillerInstanceUrl = Sys.getenv("DISTILLER_INSTANCE_URL"),
  distillerToken,
  timeout = 1800,
  attempts = 1,
  retryEach = 600,
  verbose = TRUE
)

Arguments

projectId	integer. The ID of the project as provided by DistillerSR.
reportId	integer. The ID of the report as provided by DistillerSR.
format	character (string). The desired format for the document. It can be either excel or csv.
distillerInstanceUrl	character (string). The distiller instance URL. By default: Sys.getenv("DISTILLER_INSTANCE_URL").
distillerToken	character (string). The token the user gets once authenticated.
timeout	integer. The maximum number of seconds to wait for the response. By default: 1800 seconds (30 minutes).
attempts	integer. The maximum number of attempts. By default: 1 attempt.
retryEach	integer. The delay between attempts. By default: 600 seconds (10 minutes).
verbose	logical. A flag to specify whether to make the function verbose or not. By default: TRUE.

Value

A data frame containing the Distiller report as designed within DistillerSR.

See Also

getAuthenticationToken

getProjects

getReports

Examples

## Not run: 
distillerToken_ <- getAuthenticationToken()

projects_ <- getProjects(distillerToken = distillerToken_)

reports_ <- getReports(
  projectId = projects_$id[1],
  distillerToken = distillerToken_)
  
report_ <- getReport(
  projectId = projects_$id[1],
  reportID = reports_$id[7],
  format = "csv",
  distillerToken = distillerToken_)

## End(Not run)

---

Get the list of the Distiller reports associated to a project of the authenticated user.

Description

This function queries the DistillerSR API to retrieve the list of saved reports associated with a given project ID. It requires user authentication and a valid API endpoint URL. The result is a dataframe containing metadata about each saved report.

Usage

getReports(
  projectId,
  distillerInstanceUrl = Sys.getenv("DISTILLER_INSTANCE_URL"),
  distillerToken,
  timeout = 1800
)

Arguments

projectId	integer. The ID of the project as provided by DistillerSR.
distillerInstanceUrl	character (string). The distiller instance URL. By default: Sys.getenv("DISTILLER_INSTANCE_URL").
distillerToken	character (string). The token the user gets once authenticated.
timeout	integer. The maximum number of seconds to wait for the response. By default: 1800 seconds (30 minutes).

Value

A tibble with four columns:

• id: The ID of the saved report.

• name: The name of the report.

• date: The creation date of the report.

• view: The format of the report (e.g., html, csv, excel).

See Also

getAuthenticationToken

getProjects

Examples

## Not run: 
distillerToken_ <- getAuthenticationToken()

projects_ <- getProjects(distillerToken = distillerToken_)

reports_ <- getReports(
  projectId = projects_$id[1],
  distillerToken = distillerToken_)

## End(Not run)

---