exportProjectInformation: Exports the Project Information

Description Usage Arguments Details REDCap API Documentation (6.5.0) REDCap Version Known REDCap Limitations Author(s) References

View source: R/exportProjectInformation.R

Description

Retrieve a data frame with the project information.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
exportProjectInformation(rcon, ...)

## S3 method for class 'redcapDbConnection'
exportProjectInformation(rcon, ...)

## S3 method for class 'redcapApiConnection'
exportProjectInformation(
  rcon,
  ...,
  error_handling = getOption("redcap_error_handling")
)

Arguments

rcon

A REDCap connection object as generated by redcapConnection

...

Arguments to be passed to other methods.

error_handling

An option for how to handle errors returned by the API. see redcap_error

Details

If this function is used in a version of REDCap that does not support the Export Version Number function, the character string 'Version Unknown' is returned.

REDCap API Documentation (6.5.0)

This function allows you to export some of the basic attributes of a given REDCap project, such as the project's title, if it is longitudinal, if surveys are enabled, the time the project was created and moved to production, etc.

REDCap Version

6.5.0 (Perhaps earlier)

Known REDCap Limitations

None

Author(s)

Benjamin Nutter

References

Please refer to your institution's API documentation.

Additional details on API parameters are found on the package wiki at https://github.com/nutterb/redcapAPI/wiki/REDCap-API-Parameters


redcapAPI documentation built on Feb. 18, 2020, 1:09 a.m.