redcap: Redcap Wrapper Class

Description Details Value Fields Methods See Also

Description

This class is the entry point for interacting with data stored in a REDCap data repository

Details

This object facilitates R's interface with the REDCap repository.

Data can be pulled either in bulk or chunked.

Currently only metadata and records can be pulled.

It also provides other data allied tasks such as data cleaning, error reporting and formatting.

It uses a cache system and logs major events.

Show the object to view status.

Value

A redcap class with an array of data-allied functionality.

Fields

opts

RedcapConfig object that controls the mode of interaction with the data repoistory during this object's lifecycle.

Methods

format_records()

Format records to add Hmisc labels and create factors

fully_clean_records()

Clean records removing out of range values

get_clean_metadata()

Clean meta data for autogeneration of error report code

get_data_validation_report(pop = FALSE)

Get data validation report

get_formatted_data()

Get formatted records from memory

get_fully_cleaned_data()

Get fully cleaned records from memory

get_metadata()

Get raw metadata from memory

get_partially_cleaned_data()

Get partially cleaned records from memory

get_raw_data()

Get raw records from memory. If there is not data in memory, an error is raised. Use load_data() to refresh the cache.

load_data()

Stream data from REDCap. Clears the cache and loads data. < NOTE: Do this only for initial loading or when you are sure there are changes in the data repo >.

load_metadata()

Stream metadata only from REDCap

log(message, level = 0, function_name = "")

Log events <internal use>

partially_clean_records()

Clean records removing coded missing values

validate_data()

Create data validation dataset

See Also

redcap_project


Maglado/redcapdata_p documentation built on May 26, 2019, 4:37 p.m.