Package index • sardine

Connections

Creating and testing connections

sardine_connection(): Base Connection Class for Data Sources (top-level)

redcap_connection(): Create a REDCap API Connection

test_connection(): Test Connection to Data Source

test_connection(<redcap_connection>): Test REDCap API Connection

REDCap: Project and Exports

Working with REDCap projects and exporting metadata

redcap_project(): Create REDCap Project

redcap_export_arms(): Export REDCap Arms

redcap_export_events(): Export REDCap Events

redcap_export_instruments(): Export REDCap Instruments (Forms)

redcap_export_instrument_event_mappings(): Export Instrument Event Mappings

REDCap: Summaries & Reports

Completion, retention and attrition summaries

get_event_completion_summary(): Get Event Completion Summary

get_form_completion_status(): Get Form Completion Status

get_retention_summary(): Get Retention Summary

get_attrition_over_time(): Get Attrition Over Time

plot_attrition_curve(): Plot Attrition Curve

Data Quality, Tables and Exploration

Validation, descriptive tables and interactive exploration

analyze_missing_data(): Analyze Missing Data Patterns

validate_data_types(): Validate Data Types Against REDCap Dictionary

generate_data_quality_report(): Generate Data Quality Report

generate_table_one(): Generate Table One Summary Statistics

data-validation: Data Quality and Validation Functions

as_datatable(): Display an object as a DT datatable

explore_project_shiny(): Explore REDCap Project in a Shiny App

summarise_project_structure(): Summarise REDCap Project Structure

Withings: Sleep Analysis

Constructing sleep objects, reports, SRI and exports

withings_sleep(): Create a Withings Sleep Analysis Object

withings_sleep_report(): Generate a concise report for a withings_sleep object

withings_sleep_report_render(): Render a Withings sleep report to HTML or PDF

reformat.withings_sleep(): Reformat Withings Sleep Data for External Use

SRI_from_binary(): Calculate Sleep Regularity Index (SRI) from binary sleep-wake files

combine_withings_epoch_summary(): Combine Withings epoch and summary data

withings_json_to_df(): Withings JSON to Data Frame

withings_read_csv(): Read Withings CSV helper

.format_hours_and_minutes() .is_weekend() .take_col(): Withings report summary statistics

S3 print methods

Print methods for sardine classes

print(<attrition_over_time>): Print Attrition Over Time

print(<data_quality_report>): Print Data Quality Report

print(<data_type_validation>): Print Data Type Validation Results

print(<event_completion_summary>): Print Event Completion Summary

print(<missing_data_analysis>): Print Missing Data Analysis

print(<redcap_project>): Print Method for REDCap Projects

print(<retention_summary>): Print Retention Summary

print(<table_one>): Print Method for Table One