Skip to contents

All functions

all_selector()
All Voxels Series Selector
as.matrix(<fmri_series>)
Convert fmri_series to Matrix
as.matrix_dataset()
Convert to Matrix Dataset
as_delarr()
Convert backend to a delarr lazy matrix
as_delayed_array(<matrix_dataset>) as_delayed_array(<fmri_file_dataset>) as_delayed_array(<fmri_mem_dataset>)
Convert Dataset Objects to DelayedArray
as_delayed_array()
Convert Backend to DelayedArray
as_fmri_group()
Coerce a data frame into an fmri_group
as_tibble(<fmri_series>)
Convert fmri_series to Tibble
as_tibble(<fmri_study_dataset>)
Convert fmri_study_dataset to a tibble or lazy matrix
blockids()
Get Block IDs from Sampling Frame
blocklens()
Get Block Lengths from Objects
collect_chunks()
Collect all chunks from a chunk iterator
create_backend()
Create Backend Instance
data_chunk()
Create a Data Chunk Object
data_chunks()
Create Data Chunks for Processing
data_chunks(<fmri_file_dataset>)
Create Data Chunks for fmri_file_dataset Objects
data_chunks(<fmri_mem_dataset>)
Create Data Chunks for fmri_mem_dataset Objects
data_chunks(<matrix_dataset>)
Create Data Chunks for matrix_dataset Objects
dim(<fmri_series>)
Dimensions of fmri_series
exec_strategy()
Create an Execution Strategy for Data Processing
filter_subjects()
Filter subjects in an fmri_group
fmri_cache_info()
Get cache information and statistics
fmri_cache_resize()
Resize the fmridataset cache
fmri_clear_cache()
Clear fmridataset cache
fmri_dataset()
Create an fMRI Dataset Object from a Set of Scans
fmri_dataset_legacy()
Legacy fMRI Dataset Constructor
fmri_group()
Create an fmri_group (one row per subject)
fmri_h5_dataset()
Create an fMRI Dataset Object from H5 Files
fmri_latent_dataset() deprecated
Create an fMRI Dataset Object from LatentNeuroVec Files or Objects
fmri_mem_dataset()
Create an fMRI Memory Dataset Object
fmri_series()
fmri_series: fMRI Time Series Container
fmri_series_resolvers
Helpers for fmri_series spatial and temporal selection
fmri_study_dataset()
Create an fmri_study_dataset
fmri_zarr_dataset()
Create an fMRI Dataset from Zarr Arrays
generate_golden_test_data()
Generate Golden Test Data
generics
Generic Functions for fMRI Dataset Operations
get_TR()
Get TR (Repetition Time) from Sampling Frame
get_backend_registry()
Get Registered Backend Information
get_component_info()
Get Component Information
get_data()
Get Data from fMRI Dataset Objects
get_data_matrix()
Get Data Matrix from fMRI Dataset Objects
get_latent_scores()
Get Latent Scores from Dataset
get_mask()
Get Mask from fMRI Dataset Objects
get_run_duration()
Get Run Duration from Sampling Frame
get_run_lengths()
Get Run Lengths from Sampling Frame
get_spatial_loadings()
Get Spatial Loadings from Dataset
get_total_duration()
Get Total Duration from Sampling Frame
group_map()
Map a function over subjects in an fmri_group
group_reduce()
Reduce over subjects in a single pass
index_selector()
Index-based Series Selector
is.fmri_series()
Check if object is an fmri_series
is.sampling_frame()
Test if Object is a Sampling Frame
is_backend_registered()
Check if Backend is Registered
iter_subjects()
Iterate subjects one-by-one (streaming)
latent_dataset()
Latent Dataset Interface
left_join_subjects()
Left join additional subject metadata
list_backend_names()
List Registered Backend Names
mask_selector()
Mask-based Series Selector
matrix_dataset()
Matrix Dataset Constructor
mutate_subjects()
Mutate subject-level attributes
n_runs()
Get Number of Runs from Sampling Frame
n_subjects()
Number of subjects in a group
n_timepoints()
Get Number of Timepoints from Sampling Frame
ncol(<fmri_series>)
Number of columns in fmri_series
nrow(<fmri_series>)
Number of rows in fmri_series
print(<fmri_dataset>) summary(<fmri_dataset>) print(<chunkiter>) print(<data_chunk>) print(<matrix_dataset>)
Print Methods for fmridataset Objects
print(<backend_registry>)
Print Backend Registry
print(<fmri_series>)
Print Method for fmri_series Objects
print(<series_selector>)
Print Methods for Series Selectors
read_fmri_config()
read a basic fMRI configuration file
reconstruct_voxels()
Reconstruct Voxel Data from Latent Representation
register_backend()
Register a Storage Backend
resolve_indices()
Resolve Indices from Series Selector
roi_selector()
ROI-based Series Selector
sample_subjects()
Sample subjects from an fmri_group
samples()
Get Sample Indices from Sampling Frame
series()
Deprecated alias for fmri_series
series_selector
Series Selector Classes for fMRI Data
sphere_selector()
Spherical ROI Series Selector
stream_subjects()
Stream subjects with optional ordering
study_backend()
Study Backend
subject_ids()
Get Subject IDs from Multi-Subject Dataset
subjects() `subjects<-`()
Access the subjects tibble stored inside an fmri_group
unregister_backend()
Unregister a Backend
update_golden_test_data()
Update Golden Test Data
validate_fmri_group()
Validate an fmri_group object
validate_golden_test_data()
Validate Golden Test Data
voxel_selector()
Voxel Coordinate Series Selector
with_rowData()
Attach rowData metadata to a lazy matrix
write_fmri_config()
Write fMRI configuration file