amber.campaigns: Get the campaigns

In amberr: 'Amber' Electronic Data Capture Client

Get the campaigns

Description

Get the interview design campaigns.

Usage

amber.campaigns(
  amber,
  study = NULL,
  interviewDesign = NULL,
  query = list(),
  skip = 0,
  limit = 100,
  df = TRUE
)

Arguments

amber	An Amber object
study	Study identifier (name or id), optional.
interviewDesign	Interview design identifier (name or id), optional.
query	A search query
skip	Number of items to skip
limit	Max number of items
df	Return a data.frame (default is TRUE)

Value

A data.frame (or a named list of raw results when 'df' is FALSE)

See Also

Other studies functions: amber.campaign(), amber.case_report_export(), amber.case_report_form(), amber.case_report_forms(), amber.case_reports(), amber.form(), amber.form_revision(), amber.form_revisions(), amber.forms(), amber.interview_design(), amber.interview_designs(), amber.interview_export(), amber.interviews(), amber.interviews_step_actions(), amber.interviews_step_data(), amber.interviews_steps(), amber.participant(), amber.participants(), amber.studies(), amber.study()

Examples

## Not run: 
a <- amber.login("https://amber-demo.obiba.org")
amber.campaigns(a)
amber.campaigns(a, study="Liftup", interviewDesign = "Treocapa")
amber.logout(a)

## End(Not run)

amberr documentation built on April 12, 2025, 2:12 a.m.