Extract Time Series Data

A generic function to extract time series data from an object. Specific methods will determine how data is extracted based on the object's class and the indices provided.

Usage

series(x, i, ...)

# S4 method for class 'H5ClusterRun,numeric'
series(x, i, j, k, ...)

# S4 method for class 'H5ClusterRun,matrix'
series(x, i, ...)

# S4 method for class 'H5ClusterRunSummary,ANY'
series(x, i, ...)

# S4 method for class 'H5NeuroVec,integer'
series(x, i, j, k, drop = TRUE)

# S4 method for class 'H5NeuroVec,numeric'
series(x, i, j, k, drop = TRUE)

# S4 method for class 'H5NeuroVec,matrix'
series(x, i)

# S4 method for class 'H5NeuroVec,integer'
series(x, i, j, k, drop = TRUE)

# S4 method for class 'H5NeuroVec,numeric'
series(x, i, j, k, drop = TRUE)

# S4 method for class 'LatentNeuroVec,integer'
series(x, i, ...)

# S4 method for class 'LatentNeuroVec,numeric'
series(x, i, ...)

# S4 method for class 'LatentNeuroVec,ANY'
series(x, i, ...)

Arguments

x

The object from which to extract series data.

i

An index, typically specifying voxels or elements. The interpretation of `i` depends on the specific method. It can be numeric indices, a matrix of coordinates, etc.

...

Additional arguments passed to specific methods (e.g., `drop`).

j

Optional y-coordinate or further index specification used by some methods.

k

Optional z-coordinate or further index specification used by some methods.

drop

Whether to drop dimensions of length 1

Value

A matrix or vector containing the time series data. The exact format (e.g., time x voxels, or a simple vector for a single voxel) depends on the method and arguments.

See also

Methods for this generic are available for classes like H5ClusterRun.

Other H5Cluster: $,H5ClusterExperiment-method, H5ClusterExperiment, H5ClusterExperiment-class, H5ClusterRun-class, H5ClusterRunSummary-class, H5ClusteredArray-class, [,H5ClusterRun,ANY,ANY,ANY-method, [,H5ClusterRun,ANY,missing,ANY-method, as.data.frame(), as.matrix(), close(), cluster_metadata,H5ClusterExperiment-method, clusters(), dim(), h5file,H5ClusteredArray-method, linear_access-methods, make_run_full(), make_run_summary(), mask(), matrix_concat(), n_scans,H5ClusterExperiment-method, scan_metadata,H5ClusterExperiment-method, scan_names,H5ClusterExperiment-method, series_concat(), show,H5ClusterRun-method

Other H5Cluster: $,H5ClusterExperiment-method, H5ClusterExperiment, H5ClusterExperiment-class, H5ClusterRun-class, H5ClusterRunSummary-class, H5ClusteredArray-class, [,H5ClusterRun,ANY,ANY,ANY-method, [,H5ClusterRun,ANY,missing,ANY-method, as.data.frame(), as.matrix(), close(), cluster_metadata,H5ClusterExperiment-method, clusters(), dim(), h5file,H5ClusteredArray-method, linear_access-methods, make_run_full(), make_run_summary(), mask(), matrix_concat(), n_scans,H5ClusterExperiment-method, scan_metadata,H5ClusterExperiment-method, scan_names,H5ClusterExperiment-method, series_concat(), show,H5ClusterRun-method

Other H5Cluster: $,H5ClusterExperiment-method, H5ClusterExperiment, H5ClusterExperiment-class, H5ClusterRun-class, H5ClusterRunSummary-class, H5ClusteredArray-class, [,H5ClusterRun,ANY,ANY,ANY-method, [,H5ClusterRun,ANY,missing,ANY-method, as.data.frame(), as.matrix(), close(), cluster_metadata,H5ClusterExperiment-method, clusters(), dim(), h5file,H5ClusteredArray-method, linear_access-methods, make_run_full(), make_run_summary(), mask(), matrix_concat(), n_scans,H5ClusterExperiment-method, scan_metadata,H5ClusterExperiment-method, scan_names,H5ClusterExperiment-method, series_concat(), show,H5ClusterRun-method

Examples

# This is a generic function; examples are provided with its specific methods.
# For example, see help("series,H5ClusterRun-method")