Package: fmrigds 0.1.0.9000

fmrigds: Lazy, Format-Agnostic Group Analysis for fMRI

Provides a Group Data Set (GDS) abstraction and lazy analysis pipeline for first-level fMRI statistical outputs. Unifies tabular, NIfTI, HDF5, and fmristore inputs under a common sample x subject x contrast representation; supports space-aware transformations, group and meta-analytic reducers, provenance tracking, and reproducible export.

Authors:Brad Buchsbaum [aut, cre]

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

# 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

3.36 score 2 packages 11 scripts 123 exports 11 dependencies

Last updated from:2549d29da6. Checks:6 ERROR, 6 WARNING, 1 FAIL. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64ERROR219
linux-devel-x86_64WARNING215
source / vignettesERROR3234
linux-release-arm64ERROR199
linux-release-x86_64WARNING209
macos-release-arm64WARNING118
macos-release-x86_64WARNING224
macos-oldrel-arm64WARNING182
macos-oldrel-x86_64WARNING267
windows-develERROR196
windows-releaseERROR261
windows-oldrelERROR193
wasm-releaseFAIL139

Exports:add_opadd_provenance_nodealignalign_eagerapply_common_maskas_gdsas_neurovecas_neurovol_listas_planas_scalar_map_gdsassayassay_infoassaysassert_compatible_spacesassign_metaattach_weightcan_map_linearcanonicalize_nodecoef_arraycoef_cov_tricol_datacommon_maskcomputecontrast_datacontrastsderivederive_eagerdetect_adapterdigest_planexplainexplain_planextract_groupfind_mapsgdsgds_from_neurovol_nestedgds_from_neurovolsgds_from_nifti_mapsgds_from_scalar_mapsgds_metadatagds_plangds_sourcegds_to_tibbleget_adapterget_alignmentget_map_familyget_posthocget_reducergroup_olsharmonise_contrastsimage_catalogjoin_metalist_alignmentslist_map_familieslist_posthoclist_reducersload_planmake_linear_familymake_warp_familymap_assaysmap_linearmap_tomap_to_eagerMapFamilymaskmask_eagerMaskPolicymetadatamodel_matrixnew_gdsnew_image_catalognifti_sourceone_sampleop_align_to_groupop_deriveop_mapop_mask_policyop_reduceop_subset_axisop_writeOrthogonalFamilyOTFamilyplanposthocpreviewprovenance_noderead_catalogreducereduce_eagerregister_adapterregister_alignmentregister_assayregister_mapregister_nftab_adapterregister_posthocregister_reducerrelabel_subjectsrow_datasample_groupssample_labelssave_planspacespace_basisspace_from_niftispace_parcelsspace_sample_labelsspace_subsetspace_surfacespace_voxelspace_voxelssubjectssubset_eagertwo_sampleUncertaintyRuleunregister_posthocuse_weightvalidateWarpFamilywith_col_datawith_contrast_datawith_row_datawrite_catalogwrite_nifti_assayswrite_out

Dependencies:bitbit64data.tabledigesthdf5rjsonlitelatticeMatrixR6RcppRcppArmadillo

Readme and manuals

Help Manual

Help pageTopics
fmrigdsfmrigds-package fmrigds
Append an operation to a planadd_op
Append a provenance node to metadataadd_provenance_node
Align subjects into a consensus spacealign
Eagerly align subjects and compute immediatelyalign_eager
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
Coerce common R objects into a GDSas_gds as_gds.array as_gds.data.frame as_gds.list as_gds.nftab
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
Test whether an assay can be linearly mappedcan_map_linear
Canonicalize an operation nodecanonicalize_node
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
Eagerly derive statistics and compute immediatelyderive_eager
Detect the best adapter for a sourcedetect_adapter
Compute a stable digest for a plandigest_plan
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
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
Construct a lazy GDS plangds_plan
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
Harmonise contrast names in a GDSharmonise_contrasts
Discover image files and create a catalogimage_catalog
Join external metadata to catalogjoin_meta
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
Eagerly apply space transformation and compute immediatelymap_to_eager
Create a subject-aware map familyMapFamily
Apply a mask policy lazilymask
Eagerly apply mask policy and compute immediatelymask_eager
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
Create an align-to-group operation nodeop_align_to_group
Create a derive operation nodeop_derive
Create a map operation nodeop_map
Create a mask policy operation nodeop_mask_policy
Create a reduce operation nodeop_reduce
Create a subset operation nodeop_subset_axis
Create a write operation nodeop_write
Orthogonal map family helperOrthogonalFamily
Optimal transport family helperOTFamily
Coerce to a lazy plan (alias)plan
Add a post-hoc operation to a planposthoc
Preview a small block through the planpreview
Print validation reportprint.catalog_validation_report
Print method for image_catalogprint.image_catalog
Create a provenance nodeprovenance_node
Read catalog from JSON fileread_catalog
Reduce across subjects (meta-analysis)reduce
Eagerly reduce across subjects and compute immediatelyreduce_eager
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
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
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 space_voxels
Split a GDS object by a grouping variablesplit.gds
Extract subject identifiers from a GDS objectsubjects
Eagerly subset a GDS and compute immediatelysubset_eager
Subset an image catalogsubset.image_catalog
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