Package: fmrireg 0.3.0

fmrireg: Regression Analysis of Functional Magnetic Resonance Imaging Data

Provides tools for the analysis of functional magnetic resonance imaging (fMRI) data. Facilities are included to construct flexible hemodynamic response functions, experimental regressors, and conduct univariate fMRI regression analyses.

Authors:Bradley Buchsbaum [aut, cre]

fmrireg_0.3.0.tar.gz
fmrireg_0.3.0.zip(r-4.7-x86_64)fmrireg_0.3.0.zip(r-4.7-arm64)fmrireg_0.3.0.zip(r-4.6-x86_64)fmrireg_0.3.0.zip(r-4.6-arm64)fmrireg_0.3.0.zip(r-4.5-x86_64)
fmrireg_0.3.0.tgz(r-4.6-x86_64)fmrireg_0.3.0.tgz(r-4.6-arm64)fmrireg_0.3.0.tgz(r-4.5-x86_64)fmrireg_0.3.0.tgz(r-4.5-arm64)
fmrireg_0.3.0.tar.gz(r-4.7-arm64)fmrireg_0.3.0.tar.gz(r-4.7-x86_64)fmrireg_0.3.0.tar.gz(r-4.6-arm64)fmrireg_0.3.0.tar.gz(r-4.6-x86_64)
fmrireg_0.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
fmrireg/json (API)

# Install 'fmrireg' in R:
install.packages('fmrireg', repos = c('https://bbuchsbaum.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/bbuchsbaum/fmrireg/issues

Pkgdown/docs site:https://bbuchsbaum.github.io

Uses libs:
  • openblas– Optimized BLAS
  • c++– GNU Standard C++ Library v3
  • openmp– GCC OpenMP (GOMP) support library
Datasets:

On CRAN:

Conda:

openblascppopenmp

7.77 score 7 stars 1 packages 97 scripts 204 exports 126 dependencies

Last updated from:aa36776a8a. Checks:10 OK, 5 ERROR. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64OK490
linux-devel-x86_64OK628
source / vignettesOK450
linux-release-arm64OK475
linux-release-x86_64OK598
macos-release-arm64OK2015
macos-release-x86_64OK2716
macos-oldrel-arm64OK2220
macos-oldrel-x86_64OK3579
windows-devel-arm64ERROR1579
windows-devel-x86_64ERROR2306
windows-release-arm64ERROR1542
windows-release-x86_64ERROR2303
windows-oldrel-x86_64ERROR1813
wasm-releaseOK287

Exports:.fmri_lm_formula_legacy.resample_paramapply_soft_projectionar_parametersas_hrfas_manifestbaselinebaseline_modelbaseline_specbaseline_termsbatch_errorsbatch_valuesblockblockidsblocklensBSplinebuild_modelcellscoef_imagecoef_imagescoef_namescollect_resultscolumn_contrastcolumnscompute_dvarscompute_lm_contrastscompute_lm_contrasts_from_suffstatscompute_speccondition_basis_listconditionsconstructcontrastcontrast_setcontrast_weightsconvolveconvolve_designcorrelation_mapcovariatecreate_3d_blockscreate_design_matrix_from_benchmarkcreate_fmri_modeldataset_specdesign_mapdesign_matrixdesign_plotdurationsdvars_to_weightselementsengine_specengine_specsestimateestimate_betasestimate_hrfestimation_specevaluateevaluate_method_performanceevent_basisevent_factorevent_matrixevent_modelevent_tableevent_termevent_termsevent_variableexport_jobsextract_csv_dataextract_nuisance_timeseriesFcontrastsfeaturefeature_regressorfit_contrastsfit_glm_from_suffstatsfit_glm_on_transformed_seriesfit_glm_with_configfitted_hrfflip_signfmri_jobfmri_latent_lmfmri_lmfmri_lm_controlfmri_metafmri_meta_fitfmri_meta_fit_contrastsfmri_meta_fit_covfmri_meta_fit_extendedfmri_modelfmri_ols_fitfmri_rlmfmri_templatefmri_ttestfmrireg_clifrom_bidsgen_hrfgenerate_interaction_contrastgenerate_main_effect_contrastget_benchmark_summaryget_contrastsget_covariatesget_formulaget_roisget_subjectsglm_lssglm_olsglobal_onsetsgroup_datagroup_data_from_csvgroup_data_from_fmrilmgroup_data_from_h5group_data_from_niftihrfHRFhrf_smoothing_kernelhrf_spmg1Identinstall_cliinstantiateinteraction_contrastis_categoricalis_continuouslatent_framelist_benchmark_datasetsload_benchmark_datasetlongnameslowrank_controlma_parametersmatrix_framemeta_effective_nmeta_fit_vcov_cppmixed_solve_cppn_subjectsnbasisneurovec_framenifti_framenoise_specnuisanceols_t_cppols_t_vcov_cppone_against_all_contrastoneway_contrastonsetsp_valuespair_contrastpaired_diff_blockplot_contrastsPolypoly_contrastpreflightprojection_specpvaluesr_to_zread_h5_fullread_jobsread_nifti_fullrealize_datasetreduce_betasreduce_contrastsreduce_identityreduce_write_resultsregister_basisregister_engineregister_run_backendregressorresolve_basisrobust_specRobustScalerun_backendsrun_jobrun_jobssamplessampling_frameScaleScaleWithinseshortnamessimulate_bold_signalsimulate_fmri_matrixsimulate_noise_vectorsimulate_simple_datasetsoft_projectionsoft_subspace_optionsspatial_fdrstandard_errorStandardizedstatssub_basist_to_beta_set_to_dterm_indicesterm_matricestheme_fmriregtidytidy_fitted_hrftrialwiseunit_contrastvalidate_jobvalidate_templatevariance_modelvariance_specvolume_weightsweights_specwelch_t_cppwrite_resultsz_to_rzscores

Dependencies:askpassassertthatbase64encBHbigassertrbigmemorybigmemory.sribigparallelrbigstatsrbitbit64bslibcachemclicodetoolscowplotcpp11crayoncrosstalkcurldata.tabledbscandeflistdelarrDEoptimRdigestdoParalleldplyrevaluatefarverfastmapffflockfmriARfmridatasetfmridesignfmrigdsfmrihrffmrilssfontawesomeforeachfsfurrrfuturefuture.applygenericsggplot2glmnetglobalsgluegtablehdf5rhighrhmshtmltoolshtmlwidgetshttrisobanditeratorsjquerylibjsonliteknitrlabelinglaterlatticelazyevallifecyclelistenvmagrittrMASSMatrixmatrixStatsmemoisemimemmapneuroim2numDerivopensslotelparallellypatchworkpillarpkgconfigplotlypracmaprettyunitsprogresspromisespspurrrR6RANNrappdirsRColorBrewerRcppRcppArmadilloRcppEigenRcppParallelRhpcBLASctlrlangrmarkdownrmioRNiftiRNiftyRegrobustbaseroptimRSpectraS7sassscalesshapestringistringrsurvivalsystibbletidyrtidyselecttinytexutf8uuidvctrsviridisLitewithrxfunyaml

Overview and Workflow
Introduction | A complete fit first | Key Components and Workflow | 1. Data Representation | 2. Model Building | a) Hemodynamic Response Function (HRF) | b) Event Model (event_model) | c) Baseline Model (baseline_model) | d) Contrasts (pair_contrast, unit_contrast, etc.) | 3. Model Estimation (fmri_model, fmri_lm) | 4. Advanced Topics | Acceleration: Sketched / Nyström Analysis | Group-Level Meta-Analysis | Getting Started | Next Steps

Last update: 2026-09-26
Started: 2026-04-02

Sketched GLM: Temporal Sketches, Pooled AR, and Landmarks
Set up a synthetic dataset | Simulate data with AR(1) noise | Pack into an fmri dataset | Choose the approximation engine | Build parcels | Fit with Global AR + SRHT sketch | Fit with Parcel AR + SRHT sketch | Choosing a sketch | Compare sketching to an exact OLS baseline | Standard errors follow the estimator | Reduced-rank GLS with bootstrap standard errors | Landmark extension (full-voxel, global AR) | Choosing landmarks: practical guidance | What the comparisons establish | When to use which knob | Pros and cons | Practical defaults | Reproducibility tips | Next

Last update: 2026-09-26
Started: 2025-09-13

Contrasts and Hypothesis Tests
Introduction to Contrasts | Example: A 2x2 Factorial Design | Basic Contrasts: pair_contrast | Defining Pair Contrasts | Computing Contrast Weights | Unit Contrasts: Comparing to Baseline | General Contrasts with contrast() | Contrasts for Main Effects and Interactions | Polynomial Contrasts for Ordered Factors | Helper Functions for Common Comparisons | Grouping Contrasts: contrast_set | Applying Contrasts in fmri_lm | Extracting Contrast Results | Execute an omnibus F-contrast | Visualizing Contrast Weights | Working with Contrast Weights | Conclusion | Next

Last update: 2026-09-26
Started: 2019-09-29

fMRI Linear Model (GLM)
Introduction to fMRI Linear Models | Simulating a Dataset for Analysis | Fitting a Linear Model | Accounting for Temporal Autocorrelation | Handling Outliers with Row-Wise Robust Fitting | Extracting Model Results | 1. Coefficient Estimates | 2. T-Statistics and P-Values | 3. Contrasts Between Conditions | Fitted HRF Curves | Estimating the HRF Shape from Data | Comparing Models with Different HRF Bases | Summary | From first‑level to group analysis (GDS) | Next

Last update: 2026-09-26
Started: 2025-03-31

Simulating fMRI Data
Introduction to fMRI Data Simulation | Simulating Clean BOLD Signals | Simulating Structured fMRI-like Noise | Power Spectrum Analysis | Creating a Complete Dataset with Signal and Noise | Simulating Matrix Time Series with Column-Specific Variation | Summary and Comparison | Next

Last update: 2026-09-26
Started: 2025-03-31

Functional Connectivity (Seed-Based)
Overview | Creating a Test Dataset with Known Connectivity | Modeling Scanner Drift | Connectivity Analysis Using fmrireg's GLM Framework | Validating the Results | Repeated-sampling calibration | Visualizing the Connectivity Map | Extending to Real Data | Summary

Last update: 2026-09-26
Started: 2025-09-12

Data Structures and Sampling Frames
Introduction: Linking Data and Design | The sampling_frame | In-Memory Volumetric Data (neurovec_frame) | File-Based Volumetric Data (nifti_frame) | Matrix Data (matrix_frame) | Latent Data (latent_frame) | Reading a frame back | Next

Last update: 2026-09-11
Started: 2025-03-31

Plugin Development
Why use the plugin API? | How do you build a minimal dataset? | How do you register a custom basis? | How do you register a custom engine? | Which helper should you use? | How do capabilities affect the executed configuration? | How can you inspect engine specs? | What should extension authors remember?

Last update: 2026-09-11
Started: 2026-04-02

Benchmark Datasets
Introduction | Available Benchmark Datasets | Loading and Exploring a Dataset | Examining the Data Structure | Visualizing the Data | Creating Design Matrices | Does the Benchmark Recover Its Own Ground Truth? | Comparing True vs Estimated Betas | Testing Different Datasets | HRF Variability Dataset | Trial Amplitude Variability | Summary | Next

Last update: 2026-08-11
Started: 2025-05-25

Group Analysis
Overview | Create a small ROI dataset | Fit group meta-analysis | Extract coefficients and a contrast | A quick visualization | Notes on voxelwise analysis | Minimal NIfTI Example (Reproducible) | Exact contrasts and stored covariance | Two-sample t-test (Welch and OLS) on NIfTI | Combining t-statistics only (Stouffer/Fisher/Lancaster) | Meta engine via fmri_ttest with weights | ROI t-only example (Stouffer and Lancaster) | A brief recap

Last update: 2026-08-11
Started: 2025-08-31

Running one model across many subjects
The problem | A minimal, runnable example | Reducers: what each subject becomes | Discovering subjects from BIDS | Preflight before you fan out | Running: locally, in parallel, or on a cluster | Closing the loop: the group level | Summary | Next

Last update: 2026-08-11
Started: 2026-06-30

Readme and manuals

Help Manual

Help pageTopics
Plugin registration and helpers for fmrireg.fmrireg_engine_registry
Resample parameter vector with specified distribution.resample_param
Apply Soft Projection to Data and Designapply_soft_projection
Extract Estimated AR Parameters from fmri_lm Fitar_parameters ar_parameters.fmri_lm
Coerce bindings to an fmri_manifestas_manifest
Coerce NeuroVec to base arrayas.array.NeuroVec
Plot a fitted fMRI linear modelautoplot.fmri_lm plot.fmri_lm
Autoplot method for Reg objectsautoplot.Reg
Baseline specification (subject-invariant)baseline_spec
Extract per-job errors from a batch resultbatch_errors
Extract successful values from a batch resultbatch_values
Assemble the full fMRI model for a jobbuild_model
Extract Image/Volume for Coefficientcoef_image coef_image.fmri_lm
Extract Coefficient Image from fmri_ttest_fitcoef_image.fmri_ttest_fit
Extract Images/Volumes for Multiple Coefficientscoef_images coef_images.fmri_lm
Get Available Coefficient Namescoef_names coef_names.fmri_lm
Extract Coefficients from an fmri_lm Fitcoef.fmri_lm
Extract Coefficients from Meta-Analysiscoef.fmri_meta
Collect per-subject result maps into a group_data objectcollect_results
Compute DVARS (Temporal Derivative of Timecourses)compute_dvars
Compute linear model contrast statistics (public API)compute_lm_contrasts
Compute contrast statistics from sufficient statistics (public API)compute_lm_contrasts_from_suffstats
Mechanical execution specificationcompute_spec
Contrast genericcontrast
Create a contrast setcontrast_set
Apply Contrast to Meta-Analysis Resultscontrast.fmri_meta
correlation_map.fmri_modelcorrelation_map.fmri_model
Create 3D Blocks for Voxelwise Analysiscreate_3d_blocks
Create Design Matrix from Benchmark Datasetcreate_design_matrix_from_benchmark
Describe how to (re)construct a subject's datasetdataset_spec
Heatmap visualization of the combined fmri_model design matrixdesign_map.fmri_model
Design Matrix Method for fmri_lm Objectsdesign_matrix.fmri_lm
Design Matrix for fMRI Modelsdesign_matrix.fmri_model
Design Plot for fMRI Modeldesign_plot
Convert DVARS to Volume Weightsdvars_to_weights
Inspect a Registered Engine Specificationengine_spec
List Registered Engine Specificationsengine_specs
Deprecated helper: estimate()estimate
Estimate Beta Coefficients for fMRI Dataestimate_betas estimate_betas.fmri_frame
Estimate smooth condition-level hemodynamic response functionsestimate_hrf
Statistical fitting scopeestimation_spec
Evaluate Method Performance on Benchmark Datasetevaluate_method_performance
Export jobs for external / array executionexport_jobs
Extract Data for Meta-Analysis from CSVextract_csv_data
Extract Nuisance Timeseries from Maskextract_nuisance_timeseries
Fit Contrastsfit_contrasts
Fit Contrasts for Linear Model (Default Method)fit_contrasts.default
Fit Contrasts for fMRI Linear Model Objectsfit_contrasts.fmri_lm
Fit GLM from sufficient statisticsfit_glm_from_suffstats
Fit the core GLM on a transformed time-series matrixfit_glm_on_transformed_series
Fit GLM with full config (AR/robust) on a transformed seriesfit_glm_with_config
fitted_hrffitted_hrf
Compute Fitted Hemodynamic Response Functions for an fmri_lm Objectfitted_hrf.fmri_lm
Flip Sign of Coefficientsflip_sign
Benchmark fMRI datasetsfmri_benchmark_datasets
Methods for smooth HRF estimatesas.matrix.fmri_hrf_estimate coef.fmri_hrf_estimate fmri_hrf_estimate-methods predict.fmri_hrf_estimate print.fmri_hrf_estimate
Construct a per-subject job recipefmri_job
Fast fMRI Regression Model Estimation from a Latent Component Datasetfmri_latent_lm
Fit a Linear Regression Model for fMRI Data Analysisfmri_lm fmri_lm.fmri_model fmri_lm.formula
Configure an fMRI linear modelfmri_lm_control
Fit Group-Level Meta-Analysisfmri_meta
Fit Meta-Analysis Modelsfmri_meta_fit
Fit Meta-Analysis Models with Exact Contrastsfmri_meta_fit_contrasts
Fit Meta-Analysis and return packed covariance per voxelfmri_meta_fit_cov
Extended Meta-Analysis Fit with Voxelwise Covariatefmri_meta_fit_extended
Construct an fMRI Regression Modelfmri_model
OLS Fit with Optional Voxelwise Covariatefmri_ols_fit
Fit a Robust Linear Model for fMRI Data Analysisfmri_rlm
Define a subject-invariant model templatefmri_template
fmrireg t-tests for Group Analysisfmri_ttest
Run the fmrireg command line interfacefmrireg_cli
Build a manifest from a BIDS projectfrom_bids
Fast factorial contrast generatorsgenerate_interaction_contrast generate_main_effect_contrast
Get Benchmark Dataset Summaryget_benchmark_summary
Get Available Contrastsget_contrasts
Get Covariatesget_covariates
Get Available ROIsget_rois
Get Subject IDsget_subjects
GLM LSS Estimation Convenience Function (Single Trial Estimation)glm_lss
GLM OLS Estimation Convenience Functionglm_ols
Create Group Dataset for Meta-Analysisgroup_data
Create Group Dataset from CSV File or Data Framegroup_data_from_csv
Create Group Dataset from fmri_lm Objectsgroup_data_from_fmrilm
Create Group Dataset from HDF5 Filesgroup_data_from_h5
Create Group Dataset from NIfTI Filesgroup_data_from_nifti
Compute an HRF smoothing kernelhrf_smoothing_kernel
Install the fmrireg command wrapperinstall_cli
Instantiate a template into per-subject jobsinstantiate
Build an fmri_frame from a latent (basis) decompositionlatent_frame
List Available Benchmark Datasetslist_benchmark_datasets
Load fMRI Benchmark Datasetsload_benchmark_dataset
Low-rank / sketch controls for fast GLMlowrank_control
Extract Estimated MA Parameters from fmri_lm Fitma_parameters ma_parameters.fmri_lm
Build an fmri_frame from an in-memory matrixmatrix_frame
Compute Effective Sample Size for Meta-Analysismeta_effective_n
Meta-regression with ONE voxelwise covariatemeta_fit_vcov_cpp
Mixed Model Solver using Rcpp and roptimmixed_solve_cpp
Extract Number of Subjectsn_subjects
Build an fmri_frame from in-memory NeuroVec objectsneurovec_frame
Build a lazy fmri_frame from NIfTI filesnifti_frame
Temporal-noise specificationnoise_spec
OLS t-test / ANCOVA across featuresols_t_cpp
OLS with ONE voxelwise covariateols_t_vcov_cpp
Extract P-values from a Model Fitp_values p_values.fmri_lm
Helper Functions for fmri_ttestpaired_diff_block
Plot the regressors of an fmri_model over timeplot.fmri_model
Preflight-check jobs before fan-outpreflight
Print Meta-Analysis Resultsprint.fmri_meta
Print an fmri_lm_result objectprint.fmri_lm print.fmri_model print.fmri_rlm
Print method for fmri_ttest_fitprint.fmri_ttest_fit
Print Group Data Objectprint.group_data
Print Spatial FDR Resultsprint.spatial_fdr_result
Nuisance-projection specificationprojection_spec
Compute P-values from Meta-Analysispvalues
Convert Correlation to Fisher's Zr_to_z
Read All Data from HDF5 Filesread_h5_full
Read jobs exported by export_jobs()read_jobs
Read All Data from NIfTI Filesread_nifti_full
Realize the dataset described by a jobrealize_dataset
Reducer: tidy beta-estimate tablereduce_betas
Reducer: tidy contrast tablereduce_contrasts
Reducer: return the fitted model unchangedreduce_identity
Reducer: write per-subject results to disk (BIDS-keyed)reduce_write_results
Register an HRF/basis constructorregister_basis
Register a plugin engine for 'fmri_lm'register_engine
Register an execution backend for run_jobs()register_run_backend
Resolve a registered basis function by nameresolve_basis
Robust-estimation specificationrobust_spec
List registered execution backendsrun_backends
Run a single jobrun_job
Run a batch of jobsrun_jobs
Extract Standard Errors from Meta-Analysisse
Simulate fMRI Time Seriessimulate_bold_signal
Simulate fMRI Time Courses, Return Shared Onsets + Column-Specific Amplitudes/Durationssimulate_fmri_matrix
Simulate fMRI Noisesimulate_noise_vector
Simulate Complete fMRI Datasetsimulate_simple_dataset
Create Soft Projection Operatorsoft_projection
Soft Subspace Control Optionssoft_subspace_options
Soft Subspace Projection for Nuisance Removalsoft_subspace_projection
Spatially-Aware Multiple Comparisons Correctionspatial_fdr
Extract Standard Errors from a Model Fitstandard_error standard_error.fmri_latent_lm standard_error.fmri_lm
Extract Test Statistics from a Model Fitstats stats.fmri_lm
Summary of Meta-Analysis Resultssummary.fmri_meta
Summary method for fmri_ttest_fitsummary.fmri_ttest_fit
Summary of Group Data Objectsummary.group_data
Summary of Spatial FDR Resultssummary.spatial_fdr_result
Convert t-statistics to Effect Sizest_to_beta_se
Convert T-statistics to Effect Sizes and Variancest_to_d
Extract term matrices from fmri_modelterm_matrices.fmri_model
The fmrireg ggplot2 themetheme_fmrireg
Tidy generictidy
Tidy fitted HRF curves from an fmri_lm fittidy_fitted_hrf
Tidy a smooth HRF estimatetidy.fmri_hrf_estimate
Tidy Meta-Analysis Resultstidy.fmri_meta
Validate an fmri_jobvalidate_job
Validate an fmri_templatevalidate_template
Extract the structured variance modelvariance_model
Variance and reference-distribution specificationvariance_spec
Volume Quality Metrics and Temporal Weightingvolume_quality
Compute Volume Quality Weights from Datavolume_weights
Volume-weight specificationweights_spec
Welch two-sample t-test across featureswelch_t_cpp
Write Results from fMRI Analysiswrite_results
Write Results from fMRI Linear Modelwrite_results.fmri_lm
Write Meta-Analysis Resultswrite_results.fmri_meta
Back-transform Fisher's Z to Correlationz_to_r
Compute Z-scores from Meta-Analysiszscores