redcapAPI: deprecated_redcapProjectInfo – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

deprecated_redcapProjectInfo

Deprecated Functions

Description

The redcapProjectInfo function has been deprecated to avoid confusion with the API method now executed by exportProjectInformation. The replacement function is exportBundle.

Usage

redcapProjectInfo(
  rcon,
  date = TRUE,
  label = TRUE,
  meta_data = TRUE,
  users = TRUE,
  instruments = TRUE,
  events = TRUE,
  arms = TRUE,
  mappings = TRUE,
  version = TRUE,
  ...
)

## S3 method for class 'redcapDbConnection'
redcapProjectInfo(
  rcon,
  date = TRUE,
  label = TRUE,
  meta_data = TRUE,
  users = TRUE,
  instruments = TRUE,
  events = TRUE,
  arms = TRUE,
  mappings = TRUE,
  version = TRUE,
  ...
)

## S3 method for class 'redcapApiConnection'
redcapProjectInfo(
  rcon,
  date = TRUE,
  label = TRUE,
  meta_data = TRUE,
  users = TRUE,
  instruments = TRUE,
  events = TRUE,
  arms = TRUE,
  mappings = TRUE,
  version = TRUE,
  ...,
  v.number = ""
)

Arguments

`rcon`	A REDCap connection object as generated by `redcapConnection`
`date`	Logical. If `TRUE`, user expiration dates are converted to `POSIXct` objects.
`label`	Logical. If `TRUE`, the user form permissions are converted to labelled factors.
`meta_data`	Logical. Indicates if the meta data (data dictionary) should be exported.
`users`	Logical. Indicates if the users table should be exported.
`instruments`	Logical. Indicates if the instruments table should be exported.
`events`	Logical. Indicates if the event names should be exported.
`arms`	Logical. Indicates if the arms table should be exported.
`mappings`	Logical. Indicates if the form-event mappings should be exported.
`version`	Indicates if the REDCap version number should be exported. Only applicable in REDCap 6.0.0 and higher.
`...`	Arguments to be passed to other methods
`v.number`	A character string given the desired version number should the API method not be available.

redcapAPI

Interface to 'REDCap'

v2.3

GPL-2

Authors

Benjamin Nutter [aut, ctb, cre], Stephen Lane [ctb], Will Beasley [ctb], Jeffrey Horner [ctb], Will Gray [ctb], Jeremy Stephens [ctb], Marcus Lehr [ctb]

Initial release

deprecated_redcapProjectInfo

Description

Usage

Arguments

redcapAPI

We don't support your browser anymore