Package index • RosyREDCap

Shiny Application ✨

For very basic users simply launch the app and explore!

run_RosyREDCap(): run_RosyREDCap

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 RosyREDCap

setup_DB() load_DB() load_DB_from_path() load_test_DB(): Setup or Load RosyREDCap Project

update_DB(): Update REDCap Database

REDCap_diagram(): Generate REDCap Project Diagram

drop_REDCap_to_directory(): Drop REDCap Data to Directory

summarize_DB(): Summarize REDCap Database

Everything by Topic (Intermediate/Advanced)

Expands on functionality and breaksdown core feautures into more customizable parts

Project Cache

RosyREDCap 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 RosyREDCap

cache_clear(): Clear your cached projects

cache_path(): Get your Get Cache Path

check_folder_for_projects(): List File Paths of RosyREDCap Projects in a Folder

project_health_check(): project_health_check

Tokens

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

set_REDCap_token(): Set a REDCap API Token to Your Current R Session

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

test_REDCap_token(): Test REDCap API Token linked to a DB Object

Setup/Load/Save/Delete DB Object

DB 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 run_RosyREDCap.

setup_DB() load_DB() load_DB_from_path() load_test_DB(): Setup or Load RosyREDCap Project

save_DB() delete_DB(): Save or Delete DB file from the directory

Get from REDCap

For most project, even with tens-of-thousands records and hundreds of variables, this can be handeled with update_DB. This package is not presently intended for massive REDCap projects.

update_DB(): Update REDCap Database

get_REDCap_report(): Get REDCap Report

Data Helpers

Used for managing to-be-upload data

add_ID_to_DF(): add REDCap ID to any dataframe using a ref_id

find_upload_diff(): Find the DB_import and DB differences

raw_to_labelled_form(): Raw to Labelled REDCap forms

labelled_to_raw_form(): Clean to Raw REDCap forms

read_from_REDCap_upload(): Reads DB from the dropped REDCap files in dir/REDCap/upload

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.

add_REDCap_folder(): Uploads a folder name to REDCap

upload_DB_to_REDCap(): Upload from your directory to REDCap

upload_file_to_REDCap(): Upload File to REDCap

upload_file_to_REDCap_file_repository(): Uploads a file to REDCap

upload_form_to_REDCap(): Upload to REDCap

upload_transform_to_DB(): upload_transform_to_DB Transform

delete_REDCap_file(): Uploads a folder name to REDCap

delete_REDCap_records(): Delete Records from REDCap

delete_file_from_REDCap(): Delete a File from REDCap

DB Object Modifications

One of the core internal motivations for RosyREDCap 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.

clean_DB(): Clean DB columns for plotting using the metadata

deidentify_DB(): Deidentify the REDCap Database

filter_DB(): Select REDCap Records from DB

add_default_forms_transformation(): Add Default Forms Transformation to the Database

add_DB_subset(): Add a Subset to a REDCap Database

add_field_transformation(): Add Field Transformation to the Database

transform_DB(): transform_DB

untransform_DB(): Untransform DB

DB Object Outputs

Mirror your DB object to a local/cloud file system. If you have subsets, will only update file if record beloning to that subset was updated.

REDCap_diagram(): Generate REDCap Project Diagram

drop_REDCap_to_directory(): Drop REDCap Data to Directory

generate_horizontal_transform(): Horizontal Transform

generate_summary_from_subset_name(): Generate a Summary from a Subset Name

summarize_DB(): Summarize REDCap Database

run_RosyREDCap(): run_RosyREDCap

Experimental/Dev Functions

These functions are still in development and is subject to changes.

rmarkdown_DB(): rmarkdown_DB

run_quality_checks(): Run Quality Checks

edit_REDCap_while_viewing(): Edit REDCap Data While Viewing

Other Helpers

`%>%`: Pipe operator

get_dir(): get your directory

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