amberr (version 1.2.0)

amber.participant: Get a participant

Description

Get an interview design campaign participant by its code or identifier.

Usage

amber.participant(
  amber,
  code,
  study = NULL,
  interviewDesign = NULL,
  campaign = NULL,
  query = list()
)

Value

A participant object as a named list

Arguments

amber

An Amber object

code

Participant's code

study

Study identifier (name or id), optional.

interviewDesign

Interview design identifier (name or id), optional.

campaign

Campaign identifier (name or id), optional.

query

A search query

See Also

Other studies functions: amber.campaign(), amber.campaigns(), 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.participants(), amber.studies(), amber.study()

Examples

if (FALSE) {
a <- amber.login("https://amber-demo.obiba.org")
amber.campaign(a, id = "base", interviewDesign = "Adult trauma - baseline")
amber.logout(a)
}