View source: R/docsMappingMethods.R
mappingMethods | R Documentation |
These methods enable the user to export and add/modify the mappings between instruments and events. The information provided with the methods corresponds to what is provided in the 'Designate Instruments for My Events' page in the user interface.
exportMappings(rcon, arms, ...)
importMappings(rcon, data, ...)
## S3 method for class 'redcapApiConnection'
exportMappings(
rcon,
arms = NULL,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
## S3 method for class 'redcapApiConnection'
importMappings(
rcon,
data,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
rcon |
A |
arms |
|
data |
|
... |
Arguments to pass to other methods |
error_handling |
|
config |
A named |
api_param |
A named |
These methods are only applicable to longitudinal projects. If the project information reports that the project is not longitudinal, a data frame with 0 rows is returned without calling the API.
exportMappings
returns a data frame with the columns:
arm_num | The arm number for the unique event mapped to the instrument. |
unique_event_name | The unique event name to which the instrument is assigned. |
form | The REDCap assigned instrument name mapped to the event. |
importMappings
invisible returns the number of mappings added or edited.
exportMappings()
: Export instrument-event mappings.
importMappings()
: Import instrument-event mappings to the project.
exportFieldNames()
,
exportInstruments()
,
exportMetaData()
,
importMetaData()
,
exportPdf()
## Not run:
unlockREDCap(connections = c(rcon = "project_alias"),
url = "your_redcap_url",
keyring = "API_KEYs",
envir = globalenv())
# Export all mappings
exportMappings(rcon)
# Export mappings for a specific arm
exportMappings(rcon,
arms = 1)
# Import mappings
NewMapping <-
data.frame(arm_num = c(1, 1, 2),
unique_event_name = c("event_1_arm_1",
"event_2_arm_1",
"event_1_arm_2"),
form = c("registration",
"follow_up",
"registration"))
importMapping(rcon,
data = NewMapping)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.