Process and Report Gazepoint Biometrics Data

Documentation for package ‘gpbiometrics’ version 0.1.0

Help Pages

-- A --

align_gazepoint_biometrics_to_ttl	Align Gazepoint biometric samples to TTL events
analyze_gazepoint_ac_susceptance	Analyse AC EDA admittance and susceptance recordings
analyze_gazepoint_cardiorespiratory_causality	Analyse cardiorespiratory Granger-style directionality
analyze_gazepoint_skin_potential	Analyse endosomatic skin-potential recordings
assess_gazepoint_hrp_waveform_quality	Assess Gazepoint HRP waveform quality
audit_gazepoint_biometric_missingness	Audit missingness in Gazepoint biometric channels
audit_gazepoint_biometric_sampling	Audit Gazepoint biometric sampling and timing
audit_gazepoint_biometric_sync_drift	Audit Gazepoint biometric synchronization drift
audit_gazepoint_distributional_drift	Audit distributional drift across sessions or ordered blocks
audit_gazepoint_eda_artifacts	Audit Gazepoint EDA/GSR artifacts
audit_gazepoint_engagement_dial	Audit Gazepoint engagement-dial signal quality
audit_gazepoint_gsr_quality	Audit Gazepoint GSR/EDA signal quality
audit_gazepoint_gsr_units	Audit likely GSR/EDA units
audit_gazepoint_hr_quality	Audit Gazepoint heart-rate signal quality
audit_gazepoint_ibi_quality	Audit IBI/RR interval quality
audit_gazepoint_signal_activity	Audit Gazepoint biometric signal activity
audit_gazepoint_stabilization_period	Audit or trim the EDA electrode stabilization period
audit_gazepoint_time_resets	Audit Gazepoint biometric time resets

-- B --

baseline_correct_gazepoint_gsr	Baseline-correct Gazepoint GSR/EDA
baseline_correct_gazepoint_hr	Baseline-correct Gazepoint heart rate
baseline_correct_gazepoint_pupil	Baseline-correct Gazepoint pupil size

-- C --

calculate_gazepoint_rsa	Calculate respiration-informed RSA proxy features
check_gazepoint_biometric_columns	Check Gazepoint biometric columns
check_gazepoint_plot_contract	Check a Gazepoint plot return contract
chunk_gazepoint_biometrics	Chunk Gazepoint biometric data into fixed analysis episodes
classify_gazepoint_eda_response_pattern	Classify descriptive Gazepoint EDA response patterns
classify_gazepoint_scr_intervals	Classify SCRs into FIR, SIR, and TIR latency intervals
compare_gazepoint_hr_ibi_consistency	Compare Gazepoint HR and IBI-derived heart rate
convert_gazepoint_gsr_to_conductance	Convert Gazepoint GSR resistance to conductance
correct_gazepoint_eda_temperature	Correct EDA for ambient or body temperature
create_gazepoint_biometrics_checklist	Create a Gazepoint Biometrics reporting checklist
create_gazepoint_biometrics_feature_inventory	Create a gpbiometrics feature inventory
create_gazepoint_biometrics_methods_text	Create Gazepoint Biometrics methods text
create_gazepoint_biometrics_report	Create a Gazepoint Biometrics report
create_gazepoint_biometrics_report_tables	Create Gazepoint Biometrics report tables
create_gazepoint_eda_analysis_pipeline	Create a Gazepoint EDA analysis pipeline guide
create_gazepoint_preregistration_template	Create a Gazepoint biometrics preregistration template

-- D --

decompose_gazepoint_eda	Decompose Gazepoint GSR/EDA into tonic and phasic components
denoise_gazepoint_eda_autoencoder	Denoise EDA using a user-supplied autoencoder reconstruction model
denoise_gazepoint_eda_wavelet	Denoise EDA using dependency-light Haar wavelet shrinkage
denoise_gazepoint_ppg_autoencoder	Denoise PPG using a user-supplied autoencoder reconstruction model
denoise_gazepoint_quantization_noise	Add small uniform noise to reduce quantization overlap
detect_active_biometric_channels	Detect active Gazepoint biometric channels
detect_gazepoint_biometric_schema	Detect the schema of Gazepoint biometric data
detect_gazepoint_biometric_timebase	Detect the likely timebase of Gazepoint biometric data
detect_gazepoint_doubly_stochastic_changepoints	Detect stochastic change points in noisy biometric signals
detect_gazepoint_scr_events	Detect SCR-like events in Gazepoint GSR/EDA data
detect_gazepoint_scr_peaks	Detect Gazepoint SCR peaks
detect_gazepoint_time_columns	Detect Gazepoint biometric time columns
diagnose_gazepoint_biometrics_workflow	Diagnose a Gazepoint Biometrics workflow

-- E --

estimate_gazepoint_signal_lag	Estimate lag between two Gazepoint biometric signals
export_gazepoint_biometrics_report_bundle	Export a Gazepoint biometrics report bundle
export_gazepoint_rhrv_input	Export Gazepoint IBI data for RHRV-style workflows
extract_gazepoint_beats_kmeans	Extract heartbeat candidates from Gazepoint pulse using k-means
extract_gazepoint_bilateral_eda_asymmetry	Extract bilateral EDA asymmetry features
extract_gazepoint_eda_complexity	Extract EDA complexity features
extract_gazepoint_eda_spectral_power	Extract frequency-domain EDA spectral power
extract_gazepoint_eda_tvsymp	Extract time-varying spectral EDA features
extract_gazepoint_edr_pca	Extract ECG-derived respiration using PCA
extract_gazepoint_hrv_asymmetry	Extract heart-rate asymmetry features
extract_gazepoint_hrv_features	Extract time-domain HRV features from Gazepoint IBI intervals
extract_gazepoint_hrv_fragmentation	Extract heart-rate fragmentation features
extract_gazepoint_hrv_fuzzy_csi	Extract FuzzyEn and Lorenz-plot CSI HRV features
extract_gazepoint_hrv_geometric	Extract geometric HRV features
extract_gazepoint_hrv_nonlinear	Extract nonlinear HRV features from IBI/RR intervals
extract_gazepoint_hrv_rcmse	Extract refined composite multiscale entropy from HRV intervals
extract_gazepoint_hrv_rqa	Extract HRV recurrence quantification analysis features
extract_gazepoint_pdr_signals	Extract PPG-derived respiration proxy signals
extract_gazepoint_respiration_ceemdan	Extract respiration proxy using a CEEMDAN-style bridge
extract_gazepoint_scr_recovery_times	Extract SCR recovery times
extract_gazepoint_ttl_events	Extract Gazepoint TTL marker events

-- F --

filter_gazepoint_ibi_implausible	Filter implausible Gazepoint IBI values
flag_gazepoint_artifacts_svm	Flag EDA artifacts with a user-supplied SVM-style model
flag_gazepoint_biometric_dropouts	Flag biometric dropouts and flatline periods
flag_gazepoint_mad_artifacts	Flag MAD-based EDA wearable artifacts
flag_kleckner_eda_artifacts	Flag EDA artifacts using transparent Kleckner-style heuristics
format_gazepoint_biometrics_feature_inventory	Format the gpbiometrics feature inventory for users
fuse_gazepoint_respiration_kalman	Fuse respiration proxies using a Kalman filter

-- G --

get_gazepoint_plot_data	Extract stored plot data
get_gazepoint_plot_settings	Extract stored plot settings

-- I --

import_gazepoint_biometrics	Import a Gazepoint Biometrics export
import_gazepoint_biometric_folder	Import a folder of Gazepoint Biometrics exports
import_gazepoint_data_summary	Import a Gazepoint Data Summary export
import_gazepoint_lsl_xdf	Import Gazepoint-related streams from an LSL/XDF file

-- J --

join_gazepoint_biometrics_to_gp3tools	Join Gazepoint Biometrics data to gp3tools-style eye-tracking data
join_gazepoint_biometrics_to_master	Join Gazepoint Biometrics to a master table

-- M --

model_gazepoint_eda_point_process	Model EDA events as a dependency-light point process
model_gazepoint_hrv_ipfm	Model heartbeat timing using an IPFM-style impulse train
model_gazepoint_hr_point_process	Model heartbeats as a dependency-light point process

-- O --

optimize_gazepoint_cvxeda_tau

Optimise subject-specific cvxEDA slow time constant

-- P --

plot_gazepoint_aoi_biometrics	Plot AOI-linked biometric summaries
plot_gazepoint_biometric_quality	Plot Gazepoint biometric quality indicators
plot_gazepoint_biometric_report_dashboard	Create a lightweight Gazepoint biometric QC plot dashboard
plot_gazepoint_biometric_signals	Plot Gazepoint biometric signal time series
plot_gazepoint_eda_decomposition	Plot Gazepoint EDA decomposition channels
plot_gazepoint_eda_gram	Plot an EDA-gram-style time-frequency representation
plot_gazepoint_multimodal_timeline	Plot multimodal Gazepoint biometric timelines
plot_gazepoint_saccade_main_sequence	Plot Gazepoint saccade main-sequence diagnostics
plot_gazepoint_scr_events	Plot Gazepoint SCR events on an EDA signal
plot_gazepoint_scr_specification_curve	Plot an SCR specification curve
plot_gazepoint_signal_activity	Plot Gazepoint biometric signal activity
plot_gazepoint_time_resets	Plot Gazepoint time resets and time-order flags
prepare_gazepoint_aoi_biometrics_model_data	Prepare AOI-biometric model data
prepare_gazepoint_artifact_svm_features	Prepare EDA artifact-classifier segment features
prepare_gazepoint_biometrics_lme_data	Prepare Gazepoint biometric summaries for mixed-model analysis
prepare_gazepoint_ctsi_input	Prepare Gazepoint EDA data for CTSI sparse deconvolution workflows
prepare_gazepoint_cvxeda_input	Prepare Gazepoint EDA input for external cvxEDA-style workflows
prepare_gazepoint_ledalab_input	Prepare Gazepoint EDA input for external Ledalab-style workflows
prepare_gazepoint_multimodal_model_data	Prepare Gazepoint multimodal model data
prepare_gazepoint_neurokit_eda_input	Prepare Gazepoint EDA input for NeuroKit2-style workflows
prepare_gazepoint_pspm_dcm_input	Prepare Gazepoint EDA data for PsPM DCM workflows
prepare_gazepoint_pspm_input	Prepare Gazepoint EDA input for external PsPM-style workflows
prepare_gazepoint_pyppg_input	Prepare Gazepoint HRP/PPG waveform input for pyPPG
prepare_gazepoint_rhrv_input	Prepare Gazepoint IBI/RR data for RHRV
prepare_gazepoint_scr_hurdle_model_data	Prepare Gazepoint SCR hurdle-model data

-- R --

recommend_gazepoint_biometric_exclusions	Recommend Gazepoint biometric exclusions
regress_gazepoint_pupil_luminance	Regress stimulus luminance from pupil diameter
run_gazepoint_automated_statistics	Run automated exploratory statistics for Gazepoint feature tables
run_gazepoint_biometrics_real_data_readiness	Run a final real-data readiness gate for Gazepoint biometrics data
run_gazepoint_biometrics_workflow	Run a Gazepoint Biometrics workflow
run_gazepoint_eda_analysis_pipeline	Run a six-phase Gazepoint EDA/GSR analysis pipeline
run_gazepoint_neurokit_eda_crosscheck	Optionally run a NeuroKit2 EDA cross-check
run_gazepoint_online_design_optimization	Run blockwise online design optimization decision support
run_gazepoint_scr_multiverse	Run a multiverse of SCR scoring specifications
run_gazepoint_scr_threshold_sensitivity	Run Gazepoint SCR threshold sensitivity checks
run_gpbiometrics_shiny	Launch a lightweight gpbiometrics Shiny dashboard
run_gpbiometrics_shiny_annotator	Launch a lightweight gpbiometrics Shiny peak/artifact annotator

-- S --

screen_gazepoint_eda_nonresponders	Screen Gazepoint EDA/SCR nonresponders
simulate_gazepoint_biometrics	Simulate Gazepoint-style biometric signals
smooth_gazepoint_biometrics	Smooth a Gazepoint biometric signal
standardise_gazepoint_adaptive_ema	Adaptive EMA normalization for non-stationary EDA
standardise_gazepoint_biometrics_within_unit	Standardize biometric signals within participant or other analysis units
standardise_gazepoint_biometric_names	Standardise Gazepoint biometric column names
standardise_gazepoint_plot_contract	Standardise a Gazepoint plot return contract
standardise_gazepoint_range_correction	Standardise SCR or SCL using within-participant range correction
standardise_gazepoint_zscore	Standardise SCR or SCL using intra-individual z-scoring
standardize_gazepoint_adaptive_ema	Adaptive EMA normalization for non-stationary EDA
standardize_gazepoint_biometrics_within_unit	Standardize biometric signals within participant or other analysis units
standardize_gazepoint_plot_contracts	Standardize Gazepoint plot return contracts
standardize_gazepoint_range_correction	Standardise SCR or SCL using within-participant range correction
standardize_gazepoint_zscore	Standardise SCR or SCL using intra-individual z-scoring
summarise_gazepoint_aoi_biometrics	Summarise biometric signals by AOI
summarise_gazepoint_biometrics_feature_inventory	Summarise the formatted gpbiometrics feature inventory
summarise_gazepoint_biometrics_workflow	Summarise a Gazepoint Biometrics workflow object
summarise_gazepoint_biometric_validity	Summarise validity and availability of Gazepoint biometric signals
summarise_gazepoint_dial_windows	Summarise Gazepoint engagement-dial windows
summarise_gazepoint_engagement_windows	Summarise Gazepoint engagement-dial windows
summarise_gazepoint_full_biometric_windows	Summarise full Gazepoint biometric windows
summarise_gazepoint_gsr_tonic_phasic	Summarise tonic and phasic GSR/EDA components
summarise_gazepoint_gsr_windows	Summarise Gazepoint GSR/EDA windows
summarise_gazepoint_hrv_features	Summarise time-domain HRV features from Gazepoint IBI/RR intervals
summarise_gazepoint_hr_windows	Summarise Gazepoint heart-rate windows
summarise_gazepoint_ibi_hrv_windows	Summarise Gazepoint IBI-derived HRV windows
summarise_gazepoint_ibi_windows	Summarise IBI/RR windows
summarise_gazepoint_multimodal_windows	Summarise Gazepoint multimodal biometric windows
summarise_gazepoint_scr_event_windows	Summarise Gazepoint SCR responses in event windows
sync_gazepoint_biometrics_with_gaze	Synchronise Gazepoint Biometrics with gaze data

-- T --

test_gazepoint_hrv_nonlinearity

Test HRV nonlinearity using surrogate data

-- V --

validate_gazepoint_biometrics

Validate a Gazepoint Biometrics export

-- W --

write_gazepoint_biometrics_report_tables

Write Gazepoint Biometrics report tables