Package index
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.
-
sync() - Synchronize your REDCaps
-
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
-
check_folder_for_projects() - List File Paths of REDCapSync Projects in a Folder
-
project_health_check() - project_health_check
-
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 Functions
Run Syncs on periodic bases; sync is “hands-free”, while sync_project uses project object in the environment.
-
sync() - Synchronize your REDCaps
-
sync_project() - 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_default_project_transformation()add_project_defaults()default_project_transformation()add_default_project_fields()add_project_transformation()add_default_project_summary() - Add Default Forms Transformation to the Database
-
add_project_field()experimental - Add Field Transformation to the Database
-
add_project_summary()experimental - Add a Subset to a REDCap Database
-
clear_project_summaries() - 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
-
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
-
read_from_REDCap_upload() - Reads project from the dropped REDCap files in dir/REDCap/upload
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_project_to_REDCap() - Upload from your directory to REDCap
-
upload_form_to_REDCap() - Upload to REDCap
-
upload_transform_to_project() - upload_transform_to_project Transform
-
rmarkdown_project()experimental - rmarkdown_project
-
run_quality_checks() - Run Quality Checks
-
edit_REDCap_while_viewing() - Edit REDCap Data While Viewing
-
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