Skip to contents

All functions

H5ClusterExperiment-class
H5ClusterExperiment Class
H5ClusterExperiment()
Constructor for H5ClusterExperiment Objects
H5ClusterRun-class
H5ClusterRun Class
H5ClusterRun()
Constructor for H5ClusterRun Objects
H5ClusterRunSummary-class
H5ClusterRunSummary Class
H5ClusterRunSummary()
Constructor for H5ClusterRunSummary Objects
H5NeuroVec-class
H5NeuroVec Class
H5NeuroVec()
H5NeuroVec Constructor
H5NeuroVol-class
H5NeuroVol Class
H5NeuroVol()
H5NeuroVol Constructor
LabeledVolumeSet-class
LabeledVolumeSet Class
LatentNeuroVec-class
LatentNeuroVec Class
LatentNeuroVec()
Create a Latent Space Representation of Neuroimaging Data
as.array(<LatentNeuroVec>)
Convert LatentNeuroVec to Array
as.data.frame()
Convert to Data Frame
as.matrix()
Convert to Matrix
as_h5(<NeuroVol>)
Convert a NeuroVol to HDF5 Format (as_h5 Method)
as_h5()
Generic function to convert R objects to HDF5 format
basis()
Get the basis matrix (temporal components)
`$`(<H5ClusterExperiment>)
Accessor Methods for H5ClusterExperiment Access Slots/Properties using `$`
close()
Close an Object
cluster_metadata(<H5ClusterExperiment>)
Get cluster metadata
cluster_metadata()
Get cluster metadata
clusters()
Get the cluster map object
concat(<LatentNeuroVec>,<LatentNeuroVec>)
Concatenate LatentNeuroVec Objects
`[`(<H5ClusterRun>,<ANY>,<missing>,<ANY>) `[`(<H5ClusterRunSummary>,<ANY>,<ANY>,<ANY>) `[`(<H5ClusterRunSummary>,<ANY>,<missing>,<ANY>) `[`(<H5NeuroVec>,<numeric>,<numeric>,<ANY>) `[[`(<LabeledVolumeSet>,<numeric>) `[[`(<LabeledVolumeSet>,<character>) `[[`(<LatentNeuroVec>,<numeric>) `[`(<LatentNeuroVec>,<numeric>,<numeric>,<ANY>) `[`(<LatentNeuroVec>,<ANY>,<ANY>,<ANY>)
Extract data from H5ClusterRun with missing j parameter
h5file(<H5ClusteredArray>) h5file(<H5ClusterExperiment>)
Get the HDF5 file object via generic
h5file()
Get the HDF5 file object
loadings()
Get the loadings matrix (spatial components)
make_run_full()
Constructor for H5ClusterRun Objects
make_run_summary()
Constructor for H5ClusterRunSummary Objects
map()
Get the index map volume
mask()
Get the mask volume
matrix_concat()
Concatenate Cluster Summary Matrices Across Runs (Generic)
n_scans(<H5ClusterExperiment>)
Get number of scans
n_scans()
Get the number of scans
neurovecseq_to_h5()
Convert NeuroVecSeq to HDF5
offset()
Get the offset vector
read_labeled_vec()
Read a Labeled Neuroimaging Volume Set from HDF5
scan_metadata(<H5ClusterExperiment>)
Get scan metadata
scan_metadata()
Get scan metadata
scan_names(<H5ClusterExperiment>)
Get scan names
scan_names()
Get the scan names
series()
Extract Time Series Data
series_concat()
Concatenate Voxel Time Series Across Runs (Generic)
show(<H5NeuroVec>)
Display an H5NeuroVec object
show(<H5NeuroVol>)
Show Method for H5NeuroVol
show(<LabeledVolumeSet>)
show method for LabeledVolumeSet
show(<H5ClusterRun>) show(<H5ClusterRunSummary>) show(<H5ClusterExperiment>) show(<LatentNeuroVec>)
Show Methods for H5Cluster Objects
`[`(<H5ClusterRun>,<ANY>,<ANY>,<ANY>)
Subset an H5ClusterRun Object
`[`(<H5NeuroVol>,<ANY>,<ANY>,<ANY>)
3D bracket subsetting for H5NeuroVol (handles partial arguments)
`[`(<LabeledVolumeSet>,<ANY>,<ANY>,<ANY>)
4D Array-like subsetting for LabeledVolumeSet
validate_latent_file()
Validate HDF5 File Against Latent Spec
write_clustered_experiment_h5()
Write Clustered Experiment Data to HDF5
write_labeled_vec()
Write a NeuroVec to an HDF5 file with NIfTI-like quaternions
write_vec(<LatentNeuroVec>,<character>,<missing>,<missing>)
Write LatentNeuroVec to HDF5 File