Package index • REDCapSync

Core Pipeline Functions (Basic)

For basic users use these core functions to maintain REDCap data pipelines. Setup or Load your project. Update from REDCap using what is already saved. Save the outputs to a directory.

get_projects(): Get your REDCap projects used by REDCapSync

setup_project() load_project() load_test_project(): Setup or Load REDCapSync Project

sync_project(): Synchronize REDCap Data

Everything by Topic (Intermediate/Advanced)

Expands on functionality and breaksdown core feautures into more customizable parts

Project Cache

REDCapSync cahces user-level project metadata (name, directory, links, last update and other details). Tokens and data are NOT stored here.

get_projects(): Get your REDCap projects used by REDCapSync

cache_clear(): Clear your cached projects

cache_path(): Get your Get Cache Path

Tokens

Tokens are required to use the REDCap API. Never share your tokens.

view_project_token(): View the REDCap API Token Stored in the Session

test_project_token(): Test REDCap API Token linked to a project Object

Setup/Load/Save/Delete project Object

project objects are R lists meant to store all metadata and data for a single REDCap project. They utilize the REDCap log to only fetch recent updates. The can be “mirrored” to a local/cloud directory to maintain file pipelines and/or used for an exploratory data analysis shiny app via RosyREDCap::run_RosyREDCap.

setup_project() load_project() load_test_project(): Setup or Load REDCapSync Project

save_project() delete_project(): Save or Delete project file from the directory

Sync Function

sync_project uses project object in the environment.

sync_project(): Synchronize REDCap Data

sync_all(): Synchronize REDCap Data

project setup Object Modifications

One of the core internal motivations for REDCapSync development was to have REDCap-project-agnositic functions that perform key transformations such as deidentify, derive fields, and transform (merge). However, these functions might not be utilized by the average user.

add_project_summary() experimental: Add a Subset to a REDCap Database

clear_project_summaries() experimental: clear_project_summaries

project Object Outputs

Mirror your project object to a local/cloud file system. If you have summaries, will only update file if record belonging to that summary was updated.

generate_project_summary() experimental: Generate a Summary from a Subset Name

Data Helpers

Used for managing to-be-upload data

find_upload_diff(): Find the project_import and project differences

raw_to_labelled_form(): Raw to Labelled REDCap forms

labelled_to_raw_form(): Clean to Raw REDCap forms

Download from, Upload to, and Delete from REDCap

Always use with caution! Package takes several steps to test and confirm uploads but ultimately the user is responsible for data changes. Remember REDCap always keeps a log of changes.

get_REDCap_report(): Get REDCap Report

upload_form_to_REDCap(): Upload to REDCap

Other Helpers

reexports %>% sanitize_token: Objects exported from other packages

nav_to_dir(): nav_to_dir

link_API_token() link_API_playground() link_REDCap_home() link_REDCap_project() link_REDCap_record(): Open Links to REDCap Pages