scale_timeseries {fMRItools}R Documentation

Scale the BOLD timeseries

Description

Scale the BOLD timeseries

Usage

scale_timeseries(
  BOLD,
  scale = c("auto", "mean", "sd", "none"),
  transpose = TRUE
)

Arguments

BOLD

fMRI data as a locations by time (V \times T) numeric matrix.

scale

Option for scaling the BOLD response.

\code{"auto"} (default) will use \code{"mean"} scaling except if demeaned 

data is detected (if any mean is less than one), in which case "sd" scaling will be used instead.

\code{"mean"} scaling will scale the data to percent local signal change.

\code{"sd"} scaling will scale the data by local standard deviation.

\code{"none"} will only center the data, not scale it.
transpose

Transpose BOLD if there are more columns than rows? (Because we usually expect the number of voxels to exceed the number of time points.) Default: TRUE.

Value

Scale to units of percent local signal change and centers


[Package fMRItools version 0.4.2 Index]