This method allows you to update some of the basic attributes of a given REDCap project, such as the project's title, if it is longitudinal, if surveys are enabled, etc. Its data format corresponds to the format in the API method Export Project Information.
importProjectInformation(rcon, data, ...)# S3 method for redcapApiConnection
importProjectInformation(
rcon,
data,
refresh = TRUE,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
a redcapConnection object.
data.frame with only one row and any subset of allowable fields to be
updated. See Details.
Additional arguments to pass to other methods.
logical(1). If TRUE, the cached project information
will be updated after the import.
An option for how to handle errors returned by the API.
see redcap_error
list Additional configuration parameters to pass to
POST. These are appended to any parameters in
rcon$config.
list Additional API parameters to pass into the
body of the API call. This provides users to execute calls with options
that may not otherwise be supported by redcapAPI.
Fields that are not editable will be quietly removed prior to
import. This allows the user to use the result of
exportProjectInformation as a template for the import.
Attributes for the project in the format specified. For any values that are boolean, they should be represented as either a '0' (no/false) or '1' (yes/true). The following project attributes can be updated:
project_title
project_language
purpose
purpose_other
project_notes
custom_record_label
secondary_unique_field
is_longitudinal
surveys_enabled
scheduling_enabled
record_autonumbering_enabled
randomization_enabled
project_irb_number
project_grant_number
project_pi_firstname
project_pi_lastname
display_today_now_button
bypass_branching_erase_field_prompt