amberr (version 1.2.0)

amber.forms: Get the forms

Description

Get the forms

Usage

amber.forms(
  amber,
  study = 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 name or identifier, optional

query

The 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.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

if (FALSE) {
a <- amber.login("https://amber-demo.obiba.org")
amber.forms(a)
amber.forms(a, study="Trauma Registry", skip = 0, limit = 10)
amber.logout(a)
}