Skip to contents

All functions

MvaMethod
MvaMethod R6 Class
add_behavior()
Add Behavior Data to PLS Specification
add_conditions()
Add Conditions to PLS Specification
add_design()
Add Design Contrasts to PLS Specification
add_group_labels()
Add Group Labels
add_site_labels()
Add Site Labels
add_subjects()
Add Subjects to PLS Specification
add_subjects_bids_manifest()
Add Subjects from BIDS as a Lagged NIfTI Manifest
add_subjects_manifest()
Add Subjects from a Lagged NIfTI Manifest
add_subjects_map_manifest()
Add Subjects from a Map Manifest
add_trial_data()
Add Trial-Level Data for Within-Subject Seed PLS
analysis-api
High-Level Analysis API
behav_pls()
Behavioral Correlates PLS
benchmark_fast_paths()
Benchmark Exact Fast Paths
bsr()
Extract Bootstrap Ratios
builder-behavior
Builder API: Add Behavior/Design Data
builder-conditions
Builder API: Add Conditions
builder-config
Builder API: Configure Analysis
builder-manifest
Builder API: Add Subjects from Manifest / GDS
builder-map-manifest
Builder API: Add Subjects from Map Manifest
builder-observation-order
Builder Helpers: Observation Ordering
builder-run
Builder API: Run Analysis
builder-subjects
Builder API: Add Subjects
check_gui_deps()
Check GUI Dependencies
confidence()
Get Confidence Intervals
configure()
Configure PLS Analysis
design_weights()
Extract Design/Behavior Weights
evaluate_prediction()
Evaluate Predictive Performance with Nested Cross-Validation
feature_weights()
Extract Feature Weights
generate_contrasts()
Generate Common Contrasts
get_condition_rows()
Get Condition Indices
get_method()
Get a Registered Method by Name
importance()
Extract Component Importance
launch_pls_gui()
Launch PLS GUI
list_methods()
List All Registered Methods
loadings()
Extract Loadings
misssvd()
SVD with Missing Value Handling
mva-accessors
Generic Accessors for Multivariate Analysis Results
mva-classes
Multivariate Analysis Data Classes
mva-method
Multivariate Analysis Method Protocol
mva-pls-methods
PLS Method Implementations for MvaMethod Protocol
mva_result_to_pls_result()
Convert an mva_result back to pls_result
n_components()
Get Number of Components
n_features()
Get Number of Voxels/Features
n_lv()
Get Number of Latent Variables
new_mva_decomposition()
Create a Multivariate Decomposition Object
new_mva_result()
Create a Multivariate Analysis Result
normalize_rows()
Normalize Rows to Unit Length
normalize_rows_cpp()
Fast Row Normalization
pipeline-analysis
Pipeline Analysis Adapters
pipeline-attach
Pipeline Attach API
pipeline-contracts
Pipeline Data Contracts
pipeline-core
Pipeline Core Helpers
pipeline-discovery
Pipeline Discovery Stages
pipeline-firstlevel
Pipeline First-Level Stages
pipeline-planning
Pipeline Planning Helpers
pipeline-pls
Pipeline PLS Stages
pipeline-spec
Pipeline Specification Helpers
pipeline_attach_summary()
Summarize a Pipeline Output Root
pipeline_build_pls_spec_from_ui()
Build a PLS Specification from UI Options
pipeline_discover()
Discover BIDS Inputs for plscli
pipeline_firstlevel_plan()
Plan First-Level Work Units
pipeline_firstlevel_run()
Run First-Level Estimation
pipeline_load_analysis_plan()
Load an Analysis Plan from Attached Outputs
pipeline_pls_plan()
Build a PLS Observation Manifest from First-Level Outputs
pipeline_pls_run()
Run PLS from a Planned Manifest
pipeline_render_report()
Render a Report from plscli Artifacts
pipeline_summarize()
Summarize Pipeline Stage Outputs
pipeline_validate()
Validate a Pipeline and Write Validation Output
plot-brain
Brain Slice Plots for PLS
plot-loadings
Loading Plots for PLS
plot-scores
Score Plots for PLS
plot(<pls_result>)
Plot S3 Method for pls_result
plot_brain()
Plot Brain Salience or BSR Map
plot_brain_ortho()
Plot Orthogonal Brain Views
plot_brain_overlay()
Plot Brain Overlay
plot_brain_summary()
Plot Brain Summary
plot_loadings()
Plot PLS Loadings
plot_pls_summary()
Plot PLS Summary
plot_scores()
Plot PLS Scores
plot_singular_values()
Plot Singular Values
pls-accessors
Result Accessors for PLS
pls-analysis
Core PLS Analysis Engine
pls-bootstrap
Bootstrap Testing for PLS
pls-classes
S3 Classes for PLS Analysis
pls-covariance
Covariance/Correlation Matrix Construction
pls-gui
Shiny GUI Launcher
pls-meancentering
Mean-Centering Operations for PLS
pls-permutation
Permutation Testing for PLS
pls-reports
Quarto Report Generation for PLS
pls-scores
Brain and Behavior Score Computation
pls-splithalf
Split-Half Validation for PLS
pls-statistics
Statistical Functions for PLS
pls-svd
SVD Operations for PLS
pls-theme
Modern PLS Plot Theme
pls-xcor
Cross-Correlation Operations
pls_analysis()
Run PLS Analysis
pls_behav_scores()
Get Behavior Scores
pls_boot_check()
Check Bootstrap Feasibility
pls_boot_ci()
Compute Bootstrap Confidence Intervals
pls_boot_order()
Generate Bootstrap Orders
pls_brain_scores()
Compute Brain Scores
pls_colors()
PLS Color Palettes
pls_corr_maps()
Correlation Maps for Behavior PLS
pls_corr_maps_notall()
Correlation Maps for Subset of Conditions
pls_design_scores()
Compute Design Scores
pls_get_covcor()
Get Covariance/Correlation for SVD
pls_is_low_variability()
Check for Low Variability
pls_lv_corrs()
Compute LV Correlations
pls_meancentering()
Apply Mean-Centering to Data Matrix
pls_method_int_to_name()
Map PLS Method Integer to Canonical String Name
pls_method_label()
Map PLS Method (Integer or String) to Human-Readable Label
pls_percentile()
Compute Percentile
pls_perm_order()
Generate Permutation Orders
pls_pvalue()
Compute P-values from Distribution
pls_result_to_mva_result()
Convert a pls_result to mva_result
pls_spec()
Create a PLS Specification Object
pls_split_multiblock_v()
Extract Task/Behavior Scores Separately (Multiblock)
pls_splithalf_test()
Run Split-Half Validation
pls_svd()
Standard PLS SVD
pls_task_mean()
Compute Task Means
pls_task_mean_ssb()
Compute Task Means with Unequal Group Sizes
pls_xcor()
Cross-Correlation of Two Matrices
pls_xcor_cpp()
Fast Cross-Correlation (All Modes)
plscli
plscli Command-Line Entry Point
plscli_main()
Run the plscli Dispatcher
predict-cv
Predictive Cross-Validation for PLS
prepare_firstlevel()
Prepare First-Level Artifacts
prepare_pls()
Prepare a Runnable PLS Specification
procrustes_boot_cpp()
Procrustes Rotation with Sign Flipping
procrustes_cpp()
Procrustes Rotation
project_scores()
Project Held-Out Observations into a Fitted Score Space
quick_pls()
Quick Run for Simple Analyses
read_pipeline_spec()
Read a plscli Pipeline Specification
register_method()
Register a Multivariate Analysis Method
render_pls_report()
Render a PLS Report
render_report()
Render PLS Report
run()
Run PLS Analysis from Specification
run_pls()
Run PLS from a Prepared or Saved Input
salience()
Extract Saliences (Brain Loadings)
scale_color_pls()
PLS Diverging Color Scale
scale_color_pls_discrete()
PLS Qualitative Color Scale
scale_fill_pls()
PLS Diverging Fill Scale
scale_fill_pls_discrete()
PLS Qualitative Fill Scale
scores()
Extract Scores
seed_pls()
Seed PLS (Functional Connectivity)
set_parallel()
Set Parallel Processing Options
significance()
Get Significance Values (P-values)
singular_values()
Extract Singular Values
site_pooling_diagnostics()
Site-Pooling Diagnostics for Multisite PLS
stability()
Extract Stability Estimates
task_mean_cpp()
Fast Task Mean Computation
theme_pls()
PLS Plot Theme
validate_pipeline_spec()
Validate a plscli Pipeline Specification
variance_explained()
Compute Explained Variance
write_pipeline_template()
Write an Example plscli YAML Specification
write_results()
Write Results to File
ws-seed-pls
Within-Subject Seed PLS (ws-fcMRI)
ws_seed_correlation()
Compute Within-Subject Seed-Voxel Correlation Maps
ws_seed_pls()
Within-Subject Seed PLS Analysis