Learn R Programming

Amber R

R package for accessing OBiBa/Amber web services:

  • list users and groups
  • list studies, forms, form revisions, case report forms and interview designs
  • extract case report and interview records with full data dictionary

Installation

Requires R >3.x.

# Install from source code repository
remotes::install_github("obiba/amberr")

Usage

Steps:

  • open connection to Amber server
  • extract and process documents
  • close connection with Amber server

Examples:

Copy Link

Version

Install

install.packages('amberr')

Monthly Downloads

189

Version

1.2.0

License

GPL-3

Issues

0

Pull Requests

0

Stars

0

Forks

1

Maintainer

Yannick Marcon

Last Published

April 3rd, 2025

Functions in amberr (1.2.0)

amber.interview_export

Export the interview records
amber.interviews

Get the interview records
amber.group

Get a group
amber.interviews_step_data

Get the data of some interviews step
amber.login

Opan a connection with Amber
amber.interviews_steps

Get the steps of interview records
amber.interviews_step_actions

Get the actions of some interviews step
amber.study

Get a study
amber.groups

Get the groups
amber.task

Get a task
amber.task_logs

Get the logs of a task
.nullToNA

Converts a NULL value to NA
amber.tasks

Get the tasks
amber.tasks_logs

Get the tasks logs
.post

Issues a POST form request to Amber for the specified resource
amber.logout

Close connection with Amber
amber.users

Get the users
amber.user

Get a user
.reportListMetrics

Display search result metrics
amber.subjects

Get subjects
amber.participant

Get a participant
amber.participants

Get the participants
.unlist

Convert list to vector
.authzHeader

Make the Authorization header value.
.delete

Issues a DELETE request to Amber for the specified resource
amber.studies

Get the studies
.makeDictionary

Turns a dictionary in JSON format into a "Opal" one (variables and categories)
.get

Issues a GET request to Amber for the specified resource
amber.interview_designs

Get the interview designs
.url

Utility method to build urls. Concatenates all arguments and adds a '/' separator between each element
.verbose

Verbose flag
amber.form

Get a form
amber.case_reports

Get the case report records
amber.form_revisions

Get the form revisions
amber.campaign

Get a campaign
amber.case_report_form

Get a case report form
amber.forms

Get the forms
amber.case_report_forms

Get the case report forms
amber.form_revision

Get a form revision
amber.campaigns

Get the campaigns
amber.case_report_export

Export the case report records
amber.interview_design

Get an interview design