Package: fmrigds 0.1.0

fmrigds: Lazy, Format-Agnostic Group Analysis for fMRI

Provides lazy, spatially typed group-analysis plans for observation-by-feature functional magnetic resonance imaging (fMRI) frames together with compatibility workflows for first-level statistical outputs represented as sample by subject by contrast Group Data Sets (GDS). Supports bounded feature-block reducers, tabular, 'NIfTI', 'HDF5', and 'fmristore' inputs, space-aware transformations, provenance tracking, and reproducible export.

Authors:Brad Buchsbaum [aut, cre]

fmrigds_0.1.0.tar.gz
fmrigds_0.1.0.zip(r-4.7-x86_64)fmrigds_0.1.0.zip(r-4.7-arm64)fmrigds_0.1.0.zip(r-4.6-x86_64)fmrigds_0.1.0.zip(r-4.6-arm64)fmrigds_0.1.0.zip(r-4.5-x86_64)
fmrigds_0.1.0.tgz(r-4.6-x86_64)fmrigds_0.1.0.tgz(r-4.6-arm64)fmrigds_0.1.0.tgz(r-4.5-x86_64)fmrigds_0.1.0.tgz(r-4.5-arm64)
fmrigds_0.1.0.tar.gz(r-4.7-arm64)fmrigds_0.1.0.tar.gz(r-4.7-x86_64)fmrigds_0.1.0.tar.gz(r-4.6-arm64)fmrigds_0.1.0.tar.gz(r-4.6-x86_64)
fmrigds_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
fmrigds/json (API)

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

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

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

On CRAN:

Conda:

openblascppopenmp

5.81 score 2 packages 22 scripts 109 exports 11 dependencies

Last updated from:fca311e7f9. Checks:11 ERROR, 4 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64ERROR223
linux-devel-x86_64ERROR276
source / vignettesOK292
linux-release-arm64ERROR218
linux-release-x86_64ERROR208
macos-release-arm64ERROR218
macos-release-x86_64OK574
macos-oldrel-arm64ERROR155
macos-oldrel-x86_64OK525
windows-devel-arm64ERROR361
windows-devel-x86_64ERROR352
windows-release-arm64ERROR473
windows-release-x86_64ERROR293
windows-oldrel-x86_64ERROR292
wasm-releaseOK188

Exports:alignapply_common_maskas_gdsas_neurovecas_neurovol_listas_planas_scalar_map_gdsassayassay_infoassaysassert_compatible_spacesassign_metaattach_weightcoef_arraycoef_cov_tricol_datacommon_maskcomputecontrast_datacontrastsderivedetect_adapterexamination_controlexamine_groupexplainexplain_planextract_groupfind_mapsfit_groupgdsgds_from_neurovol_nestedgds_from_neurovolsgds_from_nifti_mapsgds_from_scalar_mapsgds_metadatagds_sourcegds_to_tibbleget_adapterget_alignmentget_map_familyget_posthocget_reducergroup_olsgroup_planharmonise_contrastsimage_catalogjoin_metalist_alignmentslist_assayslist_map_familieslist_posthoclist_reducersload_planmake_linear_familymake_warp_familymap_assaysmap_linearmap_toMapFamilymaskMaskPolicymetadatamodel_matrixnew_gdsnew_image_catalognifti_sourceone_sampleOrthogonalFamilyOTFamilyposthocpreviewread_catalogreduceregister_adapterregister_alignmentregister_assayregister_mapregister_nftab_adapterregister_posthocregister_reducerrelabel_subjectsresult_framerow_datasample_groupssample_labelssave_planspacespace_basisspace_from_niftispace_parcelsspace_portabilityspace_sample_labelsspace_subsetspace_surfacespace_voxelsubjectstwo_sampleUncertaintyRuleunregister_posthocuse_weightvalidateWarpFamilywith_col_datawith_contrast_datawith_row_datawrite_catalogwrite_nifti_assayswrite_outwrite_report

Dependencies:bitbit64data.tabledigesthdf5rjsonlitelatticeMatrixR6RcppRcppArmadillo

Getting started with fmrigds
Why fmrigds? | What is a GDS? | Which path fits the summaries you have? | Plan first, compute later | Quick example | Building and inspecting a plan | Exploring a realised GDS | Tidy export | Deriving statistics | Group-level analysis with reduce() | Effects without first-level variance | z, t, or p summary statistics | Fixed-effects | Random-effects | Meta-regression | Repeated-measures mixed models | Post-hoc corrections | Writing results to disk | Working with NIfTI files | The pipeline at a glance | Next steps

Last update: 2026-10-10
Started: 2026-02-16

Repeated-measures mixed models
What does the input look like? | What model is fitted? | What is the fastest end-to-end path? | How are the random effects estimated? | How do first-level variance estimates enter the model? | Should variance components be pooled or fitted voxelwise? | What if your repeated-measure metadata is already separate? | What is supported, and what is intentionally out of scope? | Where do you go next?

Last update: 2026-08-06
Started: 2026-04-10

Driving fmrigds from the command line
Why use the CLI? | What are we driving? | How do you get a result quickly? | How do you inspect a source before you commit to a model? | How do you separate planning from execution? | How do you preview a saved plan? | How do you reach more complex workflows? | How do you discover available methods? | Where should you go next?

Last update: 2026-08-06
Started: 2026-04-10

Examine subjects under a group model
What data do you need? | How do you run the examination? | How do you read the action plane? | What does the residual geometry add? | How do you inspect one retained subject? | What happens to the post-hoc conclusion? | How do you share the examination?

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

Post-hoc corrections and spatial FDR
When do you need this? | Sample data | Chaining operations on realized objects | Standard FDR correction | Spatial FDR | Requirements for spatial FDR | Next steps

Last update: 2026-08-06
Started: 2025-12-13

Reading fmristore HDF5 files
When do you need this? | Two paths for reading data | Native /gds layout (Path B) | Labeled volumes (LabeledVolumeSet) | Parcellated data (H5ParcellatedScan) | Temporal policies | Space type | Latent bases (LatentNeuroVec) | Reading subsets efficiently | Provenance tracking | Quick reference | Next steps

Last update: 2026-08-06
Started: 2025-12-13

Spatial operations: masking, alignment, and mapping
When do you need this? | Building a GDS from in-memory data | Masking: dealing with missing data | Why mask? | Setting up the example | Intersection mask (the default) | Threshold mask | Other mask rules | Masking in a pipeline | Alignment: bringing subjects into a common space | Why align? | Creating test data in a latent space | Providing per-subject rotation matrices | Bundling rotations into a MapFamily | Running the alignment | Alignment followed by group analysis | Other alignment types | Space transformations with map_to() | Why transform spaces? | Setting up a mapping | Applying the transformation | How uncertainty propagation works | Combining test statistics without effect estimates | Putting it all together | Space types at a glance | Next steps

Last update: 2026-08-06
Started: 2026-02-22

Readme and manuals

Help Manual

Help pageTopics
fmrigdsfmrigds-package fmrigds
Align subjects into a consensus spacealign
Register, list, and get alignments (map families)alignment-registry get_alignment list_alignments register_alignment
Apply a common mask to two realised GDS objectsapply_common_mask
Convert a legacy rectangular GDS cube to a canonical frameas_fmri_frame.gds
Coerce common R objects into a GDSas_gds as_gds.array as_gds.data.frame as_gds.list as_gds.nftab
Project a rectangular frame to the legacy GDS cubeas_gds.fmri_frame
Convert image_catalog to GDS planas_gds.image_catalog
Convert a NeuroVec to GDSas_gds.DenseNeuroVec as_gds.NeuroVec
Convert a NeuroVol to GDSas_gds.DenseNeuroVol as_gds.NeuroVol
Convert GDS assay to a 4D NeuroVecas_neurovec
Convert GDS assay to list of NeuroVol objectsas_neurovol_list
Ensure an object is a planas_plan
Extract a single assay from a GDS objectassay
Retrieve assay metadataassay_info
Extract assays from a GDS objectassays
Assert compatibility between two spacesassert_compatible_spaces
Assign metadata via regex pattern matchingassign_meta
Attach a custom weight array to a GDSattach_weight
Stack coefficient assays into an arraycoef_array
Retrieve packed covariance triangles for OLS coefficientscoef_cov_tri
Extract column (subject) metadata from a GDS objectcol_data
Compute a common mask between two spacescommon_mask
Materialise a plan into a realised GDScompute
Extract contrast-level metadata from a GDS objectcontrast_data
Extract contrast identifiers from a GDS objectcontrasts
Record a derivation operation in a planderive
Detect the best adapter for a sourcedetect_adapter
Configure group examinationexamination_control
Examine subjects under an intended group modelexamine_group
Explain objects and plansexplain print.gds print.gds_plan
Explain a plan's operations in a tidy tableexplain_plan
Extract NeuroVol list for a specific groupextract_group
Find NIfTI map files with optional subject/contrast hooksfind_maps
Fit a registered group reducer over frame feature blocksfit_group
Create a Group Data Set (GDS)gds new_gds
Create GDS from nested structure of NeuroVol objectsgds_from_neurovol_nested
Create GDS from lists of NeuroVol objectsgds_from_neurovols
Construct a GDS from NIfTI maps discovered on diskgds_from_nifti_maps
Create a GDS from subject-level scalar NIfTI mapsas_scalar_map_gds gds_from_scalar_maps
Construct default metadata for a GDS objectgds_metadata
Define a plan source (adapter binding)gds_source
Tidy long-form export for GDSgds_to_tibble
Retrieve a registered adapterget_adapter
Retrieve a registered map family by nameget_map_family
Get post-hoc method by nameget_posthoc
Get reducer by nameget_reducer
Voxelwise OLS helpers for scalar-map group analysesgroup_ols one_sample two_sample
Construct a lazy frame-native group-analysis plangroup_plan
Harmonise contrast names in a GDSharmonise_contrasts
Discover image files and create a catalogimage_catalog
Join external metadata to catalogjoin_meta
List the assays present on a GDS (or that a reducer would produce)list_assays
List registered map familieslist_map_families
List registered post-hoc methodslist_posthoc
List registered reducerslist_reducers
Load a plan from JSONload_plan
Convenience helpers to create and register alignmentsmake_linear_family
Create a warp-based alignment family from on-disk pathsmake_warp_family
Map files to assay typesmap_assays
Create a linear map between spacesmap_linear
Add a space transformation to a planmap_to
Create a subject-aware map familyMapFamily
Apply a mask policy lazilymask
Define a mask policyMaskPolicy
Extract metadata from a GDS objectmetadata
Build a design matrix from attached col_datamodel_matrix
Create a new image catalog objectnew_image_catalog
Construct a NIfTI source specificationnifti_source
Orthogonal map family helperOrthogonalFamily
Optimal transport family helperOTFamily
Plot a group examinationplot.gds_examination
Add a post-hoc operation to a planposthoc
Built-in post-hoc correction methods and their output assaysposthoc-methods
Preview a small block through the planpreview
Print validation reportprint.catalog_validation_report
Print method for image_catalogprint.image_catalog
Read catalog from JSON fileread_catalog
Reduce across subjects (meta-analysis)reduce
Restricted repeated-measures Gaussian LMM reducersreducer-lmm
Voxelwise OLS reducer (per-sample GLM across subjects)reducer-ols-voxelwise
Register a storage adapterregister_adapter
Register an assay typeregister_assay
Register a map family on a plan or realised GDSregister_map
Register the neurotabs (NFTab) adapterregister_nftab_adapter
Register a post-hoc methodregister_posthoc
Register a reducer kernelregister_reducer
Relabel subjects in a GDSrelabel_subjects
Construct a standardized statistical result frameresult_frame
Extract row (sample) metadata from a GDS objectrow_data
Extract sample-group metadata from a GDS objectsample_groups
Extract sample labels from a GDS objectsample_labels
Save a plan to JSONsave_plan
Extract space descriptor from a GDS objectspace
Create a latent basis space descriptorspace_basis
Create a voxel space from a NIfTI filespace_from_nifti
Create a parcels/ROI space descriptorspace_parcels
Classify the portability of a GDS spacespace_portability
Create a simple label space for tabular samplesspace_sample_labels
Subset a space by sample indicesspace_subset
Create a surface space descriptorspace_surface
Create a voxel space descriptorspace_voxel
Split a GDS object by a grouping variablesplit.gds
Extract subject identifiers from a GDS objectsubjects
Lazily subset a plan, source, or realised GDSsubset.gds subset.gds_plan subset.gds_source
Subset an image catalogsubset.image_catalog
Summarize a group examinationsummary.gds_examination
Summary method for image_catalogsummary.image_catalog
Specify how uncertainty is propagated through a mapUncertaintyRule
Get unique values of a metadata columnunique.image_catalog
Unregister a post-hoc methodunregister_posthoc
Convenience helper to use a stored weight array for reductionuse_weight
Validate a GDS or planvalidate
Validate catalog consistencyvalidate.image_catalog
Deformable warp family helperWarpFamily
Attach subject-level covariates to a plan or GDSwith_col_data
Attach contrast-level metadata to a plan or GDSwith_contrast_data
Attach sample-level metadata to a plan or GDSwith_row_data
Write catalog to JSON filewrite_catalog
Write image-like GDS assays as NIfTI fileswrite_nifti_assays
Declare an output target for a planwrite_out
Write a self-contained group-examination reportwrite_report