amberr (version 1.2.0)

amber.participants: Get the participants

Description

Get the participants of one or several interview design campaign(s).

Usage

amber.participants(
  amber,
  study = NULL,
  interviewDesign = NULL,
  campaign = NULL,
  code = NULL,
  identifier = NULL,
  valid = NULL,
  query = list(),
  skip = 0,
  limit = 100,
  df = TRUE
)

Value

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

Arguments

amber

An Amber object

study

Study identifier (name or id), optional.

interviewDesign

Interview design identifier (name or id), optional.

campaign

Campaign identifier (name or id), optional.

code

Participant interview code, optional

identifier

Participant identifier, optional

valid

Participant is valid (logical): active and in the valid date range

query

A search query

skip

Number of items to skip

limit

Max number of items

df

Return a data.frame (default is TRUE)

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.participant(), amber.studies(), amber.study()

Examples

if (FALSE) {
a <- amber.login("https://amber-demo.obiba.org")

# Find all participants
amber.participants(a)

# Find all participants for a specific participant/patient study identifier
amber.participants(a, identifier = "1231")

# Find all participants which data is equal to some value
# (will not work if the data are encrypted in the database)
amber.participants(a, query = list(data.country = "fr"))

# Find the participants of a study interview campaign
amber.participants(a, study = "Liftup", campaign = "base")

amber.logout(a)
}